Purge API comment (#23451)

This PR just adds the `purge` query parameter to the swagger docs for
admin user delete.

Signed-off-by: jolheiser <john.olheiser@gmail.com>
This commit is contained in:
John Olheiser 2023-03-13 14:41:38 -05:00 committed by GitHub
parent d74a7efb60
commit 0a6f6354bb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 0 deletions

View file

@ -305,6 +305,10 @@ func DeleteUser(ctx *context.APIContext) {
// description: username of user to delete // description: username of user to delete
// type: string // type: string
// required: true // required: true
// - name: purge
// in: query
// description: purge the user from the system completely
// type: boolean
// responses: // responses:
// "204": // "204":
// "$ref": "#/responses/empty" // "$ref": "#/responses/empty"

View file

@ -493,6 +493,12 @@
"name": "username", "name": "username",
"in": "path", "in": "path",
"required": true "required": true
},
{
"type": "boolean",
"description": "purge the user from the system completely",
"name": "purge",
"in": "query"
} }
], ],
"responses": { "responses": {