From 635e7b38bd6a43aac442178f04141c1030ecc1cc Mon Sep 17 00:00:00 2001
From: zeripath <art27@cantab.net>
Date: Wed, 24 Jul 2019 09:34:11 +0100
Subject: [PATCH] Swagger: Add information to API Token header (#7585)

* Add a description to the API Token header for swagger
---
 routers/api/v1/api.go          | 1 +
 templates/swagger/v1_json.tmpl | 1 +
 2 files changed, 2 insertions(+)

diff --git a/routers/api/v1/api.go b/routers/api/v1/api.go
index 8170b79dd2..cd308fce51 100644
--- a/routers/api/v1/api.go
+++ b/routers/api/v1/api.go
@@ -43,6 +43,7 @@
 //          type: apiKey
 //          name: Authorization
 //          in: header
+//          description: API tokens must be prepended with "token" followed by a space.
 //     SudoParam:
 //          type: apiKey
 //          name: sudo
diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl
index 11f4161172..e56fa61eed 100644
--- a/templates/swagger/v1_json.tmpl
+++ b/templates/swagger/v1_json.tmpl
@@ -10390,6 +10390,7 @@
       "in": "query"
     },
     "AuthorizationHeaderToken": {
+      "description": "API tokens must be prepended with \"token\" followed by a space.",
       "type": "apiKey",
       "name": "Authorization",
       "in": "header"