synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-15 22:20:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix /audit & /insights params (#12043)

Browse Source
This commit is contained in:
Eric Paulsen
2024-02-07 08:38:54 -05:00
committed by GitHub
parent 1cf4b62867
commit 1abe0cfa1a
6 changed files with 133 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
coderd/apidoc/docs.go generated
View File

@ -228,7 +228,8 @@ const docTemplate = `{
"type": "integer",
"description": "Page limit",
"name": "limit",
"in": "query"
"in": "query",
"required": true
},
{
"type": "integer",
@ -1122,6 +1123,22 @@ const docTemplate = `{
],
"summary": "Get insights about templates",
"operationId": "get-insights-about-templates",
"parameters": [
{
"type": "integer",
"description": "Start time",
"name": "before",
"in": "query",
"required": true
},
{
"type": "integer",
"description": "End time",
"name": "after",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
@ -1147,6 +1164,22 @@ const docTemplate = `{
],
"summary": "Get insights about user activity",
"operationId": "get-insights-about-user-activity",
"parameters": [
{
"type": "integer",
"description": "Start time",
"name": "before",
"in": "query",
"required": true
},
{
"type": "integer",
"description": "End time",
"name": "after",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
@ -1172,6 +1205,22 @@ const docTemplate = `{
],
"summary": "Get insights about user latency",
"operationId": "get-insights-about-user-latency",
"parameters": [
{
"type": "integer",
"description": "Start time",
"name": "before",
"in": "query",
"required": true
},
{
"type": "integer",
"description": "End time",
"name": "after",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",

51
coderd/apidoc/swagger.json generated
View File

@ -190,7 +190,8 @@
"type": "integer",
"description": "Page limit",
"name": "limit",
"in": "query"
"in": "query",
"required": true
},
{
"type": "integer",
@ -966,6 +967,22 @@
"tags": ["Insights"],
"summary": "Get insights about templates",
"operationId": "get-insights-about-templates",
"parameters": [
{
"type": "integer",
"description": "Start time",
"name": "before",
"in": "query",
"required": true
},
{
"type": "integer",
"description": "End time",
"name": "after",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
@ -987,6 +1004,22 @@
"tags": ["Insights"],
"summary": "Get insights about user activity",
"operationId": "get-insights-about-user-activity",
"parameters": [
{
"type": "integer",
"description": "Start time",
"name": "before",
"in": "query",
"required": true
},
{
"type": "integer",
"description": "End time",
"name": "after",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
@ -1008,6 +1041,22 @@
"tags": ["Insights"],
"summary": "Get insights about user latency",
"operationId": "get-insights-about-user-latency",
"parameters": [
{
"type": "integer",
"description": "Start time",
"name": "before",
"in": "query",
"required": true
},
{
"type": "integer",
"description": "End time",
"name": "after",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",

2
coderd/audit.go
View File

@ -31,7 +31,7 @@ import (
// @Produce json
// @Tags Audit
// @Param q query string false "Search query"
// @Param limit query int false "Page limit"
// @Param limit query int true "Page limit"
// @Param offset query int false "Page offset"
// @Success 200 {object} codersdk.AuditLogResponse
// @Router /audit [get]

6
coderd/insights.go
View File

@ -64,6 +64,8 @@ func (api *API) deploymentDAUs(rw http.ResponseWriter, r *http.Request) {
// @Security CoderSessionToken
// @Produce json
// @Tags Insights
// @Param before query int true "Start time"
// @Param after query int true "End time"
// @Success 200 {object} codersdk.UserActivityInsightsResponse
// @Router /insights/user-activity [get]
func (api *API) insightsUserActivity(rw http.ResponseWriter, r *http.Request) {
@ -151,6 +153,8 @@ func (api *API) insightsUserActivity(rw http.ResponseWriter, r *http.Request) {
// @Security CoderSessionToken
// @Produce json
// @Tags Insights
// @Param before query int true "Start time"
// @Param after query int true "End time"
// @Success 200 {object} codersdk.UserLatencyInsightsResponse
// @Router /insights/user-latency [get]
func (api *API) insightsUserLatency(rw http.ResponseWriter, r *http.Request) {
@ -241,6 +245,8 @@ func (api *API) insightsUserLatency(rw http.ResponseWriter, r *http.Request) {
// @Security CoderSessionToken
// @Produce json
// @Tags Insights
// @Param before query int true "Start time"
// @Param after query int true "End time"
// @Success 200 {object} codersdk.TemplateInsightsResponse
// @Router /insights/templates [get]
func (api *API) insightsTemplates(rw http.ResponseWriter, r *http.Request) {