Swagger: Add information to API Token header (#7585)

* Add a description to the API Token header for swagger
2019-07-24 09:34:11 +01:00 · 2019-07-24 09:34:11 +01:00 · 635e7b38bd
commit 635e7b38bd
parent 2c5c458dd7
2 changed files with 2 additions and 0 deletions
--- 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
--- 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"