Browse Source

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

* Add a description to the API Token header for swagger
for-closed-social
zeripath 5 years ago
committed by GitHub
parent
commit
635e7b38bd
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 0 deletions
  1. +1
    -0
      routers/api/v1/api.go
  2. +1
    -0
      templates/swagger/v1_json.tmpl

+ 1
- 0
routers/api/v1/api.go View File

@ -43,6 +43,7 @@
// type: apiKey // type: apiKey
// name: Authorization // name: Authorization
// in: header // in: header
// description: API tokens must be prepended with "token" followed by a space.
// SudoParam: // SudoParam:
// type: apiKey // type: apiKey
// name: sudo // name: sudo

+ 1
- 0
templates/swagger/v1_json.tmpl View File

@ -10390,6 +10390,7 @@
"in": "query" "in": "query"
}, },
"AuthorizationHeaderToken": { "AuthorizationHeaderToken": {
"description": "API tokens must be prepended with \"token\" followed by a space.",
"type": "apiKey", "type": "apiKey",
"name": "Authorization", "name": "Authorization",
"in": "header" "in": "header"

Loading…
Cancel
Save