IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Swagger: Fix sync issue with enterprise (#97696)

Browse Source 
* Swagger: Fix sync issue with enterprise

* Update swagger guidelines for enterprise endpoints
This commit is contained in:
Sofia Papagiannaki 2024-12-09 21:21:22 +02:00 committed by GitHub
parent b00774f45f
commit d1027bf7b1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 125 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
pkg/api/README.md
View File

@ -12,6 +12,8 @@ Developers modifying the HTTP API endpoints need to make sure to add the necessa
The following route defines a `PATCH` endpoint under the `/serviceaccounts/{serviceAccountId}` path with tag `service_accounts` (used for grouping together several routes) and operation ID `updateServiceAccount` (used for uniquely identifying routes and associate parameters and response with them).
> For enterprise endpoints make sure you add the `enterprise` tag as well.
```go
// swagger:route PATCH /serviceaccounts/{serviceAccountId} service_accounts updateServiceAccount

107
public/api-enterprise-spec.json
View File

@ -2211,6 +2211,113 @@
}
}
},
"/scim/users/": {
"get": {
"tags": [
"users",
"enterprise"
],
"summary": "Fetches all users in UserSchema format.",
"operationId": "getUsers",
"responses": {
"200": {
"$ref": "#/responses/getUsers"
},
"400": {
"$ref": "#/responses/badRequestError"
},
"401": {
"$ref": "#/responses/unauthorisedError"
},
"404": {
"$ref": "#/responses/notFoundError"
},
"500": {
"$ref": "#/responses/internalServerError"
}
}
},
"post": {
"tags": [
"users",
"enterprise"
],
"summary": "Creates user.",
"operationId": "createUser",
"responses": {
"200": {
"$ref": "#/responses/okResponse"
},
"400": {
"$ref": "#/responses/badRequestError"
},
"401": {
"$ref": "#/responses/unauthorisedError"
},
"403": {
"$ref": "#/responses/forbiddenError"
},
"409": {
"$ref": "#/responses/conflictError"
},
"500": {
"$ref": "#/responses/internalServerError"
}
}
},
"delete": {
"tags": [
"user",
"enterprise"
],
"summary": "Deletes user.",
"operationId": "deleteUser",
"responses": {
"200": {
"$ref": "#/responses/okResponse"
},
"400": {
"$ref": "#/responses/badRequestError"
},
"401": {
"$ref": "#/responses/unauthorisedError"
},
"404": {
"$ref": "#/responses/notFoundError"
},
"500": {
"$ref": "#/responses/internalServerError"
}
}
}
},
"/scim/users/:id": {
"get": {
"tags": [
"user",
"enterprise"
],
"summary": "Gets user by id.",
"operationId": "getUser",
"responses": {
"200": {
"$ref": "#/responses/okResponse"
},
"400": {
"$ref": "#/responses/badRequestError"
},
"401": {
"$ref": "#/responses/unauthorisedError"
},
"403": {
"$ref": "#/responses/forbiddenError"
},
"500": {
"$ref": "#/responses/internalServerError"
}
}
}
},
"/teams/{teamId}/groups": {
"get": {
"tags": [

12
public/api-merged.json
View File

@ -8609,7 +8609,8 @@
"/scim/users/": {
"get": {
"tags": [
"users"
"users",
"enterprise"
],
"summary": "Fetches all users in UserSchema format.",
"operationId": "getUsers",
@ -8633,7 +8634,8 @@
},
"post": {
"tags": [
"users"
"users",
"enterprise"
],
"summary": "Creates user.",
"operationId": "createUser",
@ -8660,7 +8662,8 @@
},
"delete": {
"tags": [
"user"
"user",
"enterprise"
],
"summary": "Deletes user.",
"operationId": "deleteUser",
@ -8686,7 +8689,8 @@
"/scim/users/:id": {
"get": {
"tags": [
"user"
"user",
"enterprise"
],
"summary": "Gets user by id.",
"operationId": "getUser",

12
public/openapi3.json
View File

@ -22639,7 +22639,8 @@
},
"summary": "Deletes user.",
"tags": [
"user"
"user",
"enterprise"
]
},
"get": {
@ -22663,7 +22664,8 @@
},
"summary": "Fetches all users in UserSchema format.",
"tags": [
"users"
"users",
"enterprise"
]
},
"post": {
@ -22690,7 +22692,8 @@
},
"summary": "Creates user.",
"tags": [
"users"
"users",
"enterprise"
]
}
},
@ -22716,7 +22719,8 @@
},
"summary": "Gets user by id.",
"tags": [
"user"
"user",
"enterprise"
]
}
},