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:
parent
d74a7efb60
commit
0a6f6354bb
2 changed files with 10 additions and 0 deletions
|
@ -305,6 +305,10 @@ func DeleteUser(ctx *context.APIContext) {
|
|||
// description: username of user to delete
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: purge
|
||||
// in: query
|
||||
// description: purge the user from the system completely
|
||||
// type: boolean
|
||||
// responses:
|
||||
// "204":
|
||||
// "$ref": "#/responses/empty"
|
||||
|
|
|
@ -493,6 +493,12 @@
|
|||
"name": "username",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "boolean",
|
||||
"description": "purge the user from the system completely",
|
||||
"name": "purge",
|
||||
"in": "query"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
|
|
Loading…
Reference in a new issue