synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-13 21:36:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: correct swagger description for Insights API (#13442)

Browse Source
This commit is contained in:
Marcin Tojek
2024-06-03 15:48:31 +02:00
committed by GitHub
parent b723da9e91
commit bf98b0dfe4
4 changed files with 177 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
coderd/apidoc/docs.go generated
View File

@ -1158,6 +1158,15 @@ const docTemplate = `{
],
"summary": "Get deployment DAUs",
"operationId": "get-deployment-daus",
"parameters": [
{
"type": "integer",
"description": "Time-zone offset (e.g. -2)",
"name": "tz_offset",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
@ -1185,18 +1194,41 @@ const docTemplate = `{
"operationId": "get-insights-about-templates",
"parameters": [
{
"type": "integer",
"type": "string",
"format": "date-time",
"description": "Start time",
"name": "before",
"name": "start_time",
"in": "query",
"required": true
},
{
"type": "integer",
"type": "string",
"format": "date-time",
"description": "End time",
"name": "after",
"name": "end_time",
"in": "query",
"required": true
},
{
"enum": [
"week",
"day"
],
"type": "string",
"description": "Interval",
"name": "interval",
"in": "query",
"required": true
},
{
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"description": "Template IDs",
"name": "template_ids",
"in": "query"
}
],
"responses": {
@ -1226,18 +1258,30 @@ const docTemplate = `{
"operationId": "get-insights-about-user-activity",
"parameters": [
{
"type": "integer",
"type": "string",
"format": "date-time",
"description": "Start time",
"name": "before",
"name": "start_time",
"in": "query",
"required": true
},
{
"type": "integer",
"type": "string",
"format": "date-time",
"description": "End time",
"name": "after",
"name": "end_time",
"in": "query",
"required": true
},
{
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"description": "Template IDs",
"name": "template_ids",
"in": "query"
}
],
"responses": {
@ -1267,18 +1311,30 @@ const docTemplate = `{
"operationId": "get-insights-about-user-latency",
"parameters": [
{
"type": "integer",
"type": "string",
"format": "date-time",
"description": "Start time",
"name": "before",
"name": "start_time",
"in": "query",
"required": true
},
{
"type": "integer",
"type": "string",
"format": "date-time",
"description": "End time",
"name": "after",
"name": "end_time",
"in": "query",
"required": true
},
{
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"description": "Template IDs",
"name": "template_ids",
"in": "query"
}
],
"responses": {

77
coderd/apidoc/swagger.json generated
View File

@ -998,6 +998,15 @@
"tags": ["Insights"],
"summary": "Get deployment DAUs",
"operationId": "get-deployment-daus",
"parameters": [
{
"type": "integer",
"description": "Time-zone offset (e.g. -2)",
"name": "tz_offset",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
@ -1021,18 +1030,38 @@
"operationId": "get-insights-about-templates",
"parameters": [
{
"type": "integer",
"type": "string",
"format": "date-time",
"description": "Start time",
"name": "before",
"name": "start_time",
"in": "query",
"required": true
},
{
"type": "integer",
"type": "string",
"format": "date-time",
"description": "End time",
"name": "after",
"name": "end_time",
"in": "query",
"required": true
},
{
"enum": ["week", "day"],
"type": "string",
"description": "Interval",
"name": "interval",
"in": "query",
"required": true
},
{
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"description": "Template IDs",
"name": "template_ids",
"in": "query"
}
],
"responses": {
@ -1058,18 +1087,30 @@
"operationId": "get-insights-about-user-activity",
"parameters": [
{
"type": "integer",
"type": "string",
"format": "date-time",
"description": "Start time",
"name": "before",
"name": "start_time",
"in": "query",
"required": true
},
{
"type": "integer",
"type": "string",
"format": "date-time",
"description": "End time",
"name": "after",
"name": "end_time",
"in": "query",
"required": true
},
{
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"description": "Template IDs",
"name": "template_ids",
"in": "query"
}
],
"responses": {
@ -1095,18 +1136,30 @@
"operationId": "get-insights-about-user-latency",
"parameters": [
{
"type": "integer",
"type": "string",
"format": "date-time",
"description": "Start time",
"name": "before",
"name": "start_time",
"in": "query",
"required": true
},
{
"type": "integer",
"type": "string",
"format": "date-time",
"description": "End time",
"name": "after",
"name": "end_time",
"in": "query",
"required": true
},
{
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"description": "Template IDs",
"name": "template_ids",
"in": "query"
}
],
"responses": {

17
coderd/insights.go
View File

@ -30,6 +30,7 @@ const insightsTimeLayout = time.RFC3339
// @Security CoderSessionToken
// @Produce json
// @Tags Insights
// @Param tz_offset query int true "Time-zone offset (e.g. -2)"
// @Success 200 {object} codersdk.DAUsResponse
// @Router /insights/daus [get]
func (api *API) deploymentDAUs(rw http.ResponseWriter, r *http.Request) {
@ -100,8 +101,9 @@ func (api *API) returnDAUsInternal(rw http.ResponseWriter, r *http.Request, temp
// @Security CoderSessionToken
// @Produce json
// @Tags Insights
// @Param before query int true "Start time"
// @Param after query int true "End time"
// @Param start_time query string true "Start time" format(date-time)
// @Param end_time query string true "End time" format(date-time)
// @Param template_ids query []string false "Template IDs" collectionFormat(csv)
// @Success 200 {object} codersdk.UserActivityInsightsResponse
// @Router /insights/user-activity [get]
func (api *API) insightsUserActivity(rw http.ResponseWriter, r *http.Request) {
@ -202,8 +204,9 @@ 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"
// @Param start_time query string true "Start time" format(date-time)
// @Param end_time query string true "End time" format(date-time)
// @Param template_ids query []string false "Template IDs" collectionFormat(csv)
// @Success 200 {object} codersdk.UserLatencyInsightsResponse
// @Router /insights/user-latency [get]
func (api *API) insightsUserLatency(rw http.ResponseWriter, r *http.Request) {
@ -294,8 +297,10 @@ 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"
// @Param start_time query string true "Start time" format(date-time)
// @Param end_time query string true "End time" format(date-time)
// @Param interval query string true "Interval" enums(week,day)
// @Param template_ids query []string false "Template IDs" collectionFormat(csv)
// @Success 200 {object} codersdk.TemplateInsightsResponse
// @Router /insights/templates [get]
func (api *API) insightsTemplates(rw http.ResponseWriter, r *http.Request) {