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>

diff --git a/routers/api/v1/admin/user.go b/routers/api/v1/admin/user.go
index 1fbdab3e5598ab92825f914bce3d169fb4a94334..4192d8654d7c4f36e3894f5fb4a6cb8e33da2f07 100644 (file)
--- 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"

diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl
index cb88e175ea5f8247b62edfee7df738bfc063f16f..b64f6dcd87dcf483e1ecad63aca4a18253b21d9b 100644 (file)
--- a/templates/swagger/v1_json.tmpl
+++ b/templates/swagger/v1_json.tmpl
@@ -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": {