summaryrefslogtreecommitdiffstats
path: root/routers/api
diff options
context:
space:
mode:
authorJohn Olheiser <john.olheiser@gmail.com>2023-03-13 14:41:38 -0500
committerGitHub <noreply@github.com>2023-03-13 14:41:38 -0500
commit0a6f6354bbc03d4a3ad382a432113301e9ea9d86 (patch)
tree1207b1ba33343f2b3899027c1f46393f93bcd833 /routers/api
parentd74a7efb60f94a4b8e6e5f65332f94f1be31b761 (diff)
downloadgitea-0a6f6354bbc03d4a3ad382a432113301e9ea9d86.tar.gz
gitea-0a6f6354bbc03d4a3ad382a432113301e9ea9d86.zip
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>
Diffstat (limited to 'routers/api')
-rw-r--r--routers/api/v1/admin/user.go4
1 files changed, 4 insertions, 0 deletions
diff --git a/routers/api/v1/admin/user.go b/routers/api/v1/admin/user.go
index 1fbdab3e55..4192d8654d 100644
--- a/routers/api/v1/admin/user.go
+++ b/routers/api/v1/admin/user.go
@@ -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"