Add OpenAPI annotations for query params of `getOrgUsersForCurrentOrg` API route (#101419)

This commit is contained in:
xavi 2025-02-28 13:41:58 +01:00 committed by GitHub
parent f5e5824bab
commit ec29f6cb60
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 40 additions and 0 deletions

View File

@ -542,6 +542,16 @@ type AddOrgUserParams struct {
OrgID int64 `json:"org_id"`
}
// swagger:parameters getOrgUsersForCurrentOrg
type GetOrgUsersForCurrentOrgParams struct {
// in:query
// required:false
Query string `json:"query"`
// in:query
// required:false
Limit int `json:"limit"`
}
// swagger:parameters getOrgUsersForCurrentOrgLookup
type LookupOrgUsersParams struct {
// in:query

View File

@ -6457,6 +6457,19 @@
],
"summary": "Get all users within the current organization.",
"operationId": "getOrgUsersForCurrentOrg",
"parameters": [
{
"type": "string",
"name": "query",
"in": "query"
},
{
"type": "integer",
"format": "int64",
"name": "limit",
"in": "query"
}
],
"responses": {
"200": {
"$ref": "#/responses/getOrgUsersForCurrentOrgResponse"

View File

@ -20308,6 +20308,23 @@
"get": {
"description": "Returns all org users within the current organization. Accessible to users with org admin role.\nIf you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `org.users:read` with scope `users:*`.",
"operationId": "getOrgUsersForCurrentOrg",
"parameters": [
{
"in": "query",
"name": "query",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"schema": {
"format": "int64",
"type": "integer"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/getOrgUsersForCurrentOrgResponse"