mirror of https://github.com/coder/coder.git
docs: fix /audit & /insights params (#12043)
This commit is contained in:
Eric Paulsen
GitHub
parent
1cf4b62867
commit
1abe0cfa1a
|
|
@ -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",
|
||||
|
|
|
|||
|
|
@ -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",
|
||||
|
|
|
|||
|
|
@ -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]
|
||||
|
|
|
|||
|
|
@ -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) {
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
```shell
|
||||
# Example request using curl
|
||||
curl -X GET http://coder-server:8080/api/v2/audit \
|
||||
curl -X GET http://coder-server:8080/api/v2/audit?limit=0 \
|
||||
-H 'Accept: application/json' \
|
||||
-H 'Coder-Session-Token: API_KEY'
|
||||
```
|
||||
|
|
@ -18,7 +18,7 @@ curl -X GET http://coder-server:8080/api/v2/audit \
|
|||
| Name | In | Type | Required | Description |
|
||||
| -------- | ----- | ------- | -------- | ------------ |
|
||||
| `q` | query | string | false | Search query |
|
||||
| `limit` | query | integer | false | Page limit |
|
||||
| `limit` | query | integer | true | Page limit |
|
||||
| `offset` | query | integer | false | Page offset |
|
||||
|
||||
### Example responses
|
||||
|
|
|
|||
|
|
@ -43,13 +43,20 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
|
|||
|
||||
```shell
|
||||
# Example request using curl
|
||||
curl -X GET http://coder-server:8080/api/v2/insights/templates \
|
||||
curl -X GET http://coder-server:8080/api/v2/insights/templates?before=0&after=0 \
|
||||
-H 'Accept: application/json' \
|
||||
-H 'Coder-Session-Token: API_KEY'
|
||||
```
|
||||
|
||||
`GET /insights/templates`
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | In | Type | Required | Description |
|
||||
| -------- | ----- | ------- | -------- | ----------- |
|
||||
| `before` | query | integer | true | Start time |
|
||||
| `after` | query | integer | true | End time |
|
||||
|
||||
### Example responses
|
||||
|
||||
> 200 Response
|
||||
|
|
@ -121,13 +128,20 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
|
|||
|
||||
```shell
|
||||
# Example request using curl
|
||||
curl -X GET http://coder-server:8080/api/v2/insights/user-activity \
|
||||
curl -X GET http://coder-server:8080/api/v2/insights/user-activity?before=0&after=0 \
|
||||
-H 'Accept: application/json' \
|
||||
-H 'Coder-Session-Token: API_KEY'
|
||||
```
|
||||
|
||||
`GET /insights/user-activity`
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | In | Type | Required | Description |
|
||||
| -------- | ----- | ------- | -------- | ----------- |
|
||||
| `before` | query | integer | true | Start time |
|
||||
| `after` | query | integer | true | End time |
|
||||
|
||||
### Example responses
|
||||
|
||||
> 200 Response
|
||||
|
|
@ -165,13 +179,20 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
|
|||
|
||||
```shell
|
||||
# Example request using curl
|
||||
curl -X GET http://coder-server:8080/api/v2/insights/user-latency \
|
||||
curl -X GET http://coder-server:8080/api/v2/insights/user-latency?before=0&after=0 \
|
||||
-H 'Accept: application/json' \
|
||||
-H 'Coder-Session-Token: API_KEY'
|
||||
```
|
||||
|
||||
`GET /insights/user-latency`
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | In | Type | Required | Description |
|
||||
| -------- | ----- | ------- | -------- | ----------- |
|
||||
| `before` | query | integer | true | Start time |
|
||||
| `after` | query | integer | true | End time |
|
||||
|
||||
### Example responses
|
||||
|
||||
> 200 Response
|
||||
|
|
|
|||
Loading…
Reference in New Issue