From 0a6f6354bbc03d4a3ad382a432113301e9ea9d86 Mon Sep 17 00:00:00 2001
From: John Olheiser <john.olheiser@gmail.com>
Date: Mon, 13 Mar 2023 14:41:38 -0500
Subject: [PATCH] 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>
---
 routers/api/v1/admin/user.go   | 4 ++++
 templates/swagger/v1_json.tmpl | 6 ++++++
 2 files changed, 10 insertions(+)

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"
diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl
index cb88e175ea..b64f6dcd87 100644
--- 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": {