mirror of
https://github.com/gotify/server.git
synced 2026-07-01 02:44:19 +08:00
Update docs
This commit is contained in:
committed by
Jannis Mattheis
parent
70e1fd1863
commit
0fb584d7f7
@@ -7,7 +7,8 @@
|
||||
// __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app)
|
||||
// __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script)
|
||||
//
|
||||
// The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`.
|
||||
// The token can be transmitted in a header named `X-Gotify-Key`, in a query parameter named `token` or
|
||||
// through a header named `Authorization` with the value prefixed with `Bearer` (Ex. `Bearer randomtoken`).
|
||||
// There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken.
|
||||
//
|
||||
// \---
|
||||
@@ -16,7 +17,7 @@
|
||||
//
|
||||
// Schemes: http, https
|
||||
// Host: localhost
|
||||
// Version: 2.0.1
|
||||
// Version: 2.0.2
|
||||
// License: MIT https://github.com/gotify/server/blob/master/LICENSE
|
||||
//
|
||||
// Consumes:
|
||||
@@ -42,6 +43,18 @@
|
||||
// type: apiKey
|
||||
// name: X-Gotify-Key
|
||||
// in: header
|
||||
// appTokenAuthorizationHeader:
|
||||
// type: apiKey
|
||||
// name: Authorization
|
||||
// in: header
|
||||
// description: >-
|
||||
// Enter an application token with the `Bearer` prefix, e.g. `Bearer Axxxxxxxxxx`.
|
||||
// clientTokenAuthorizationHeader:
|
||||
// type: apiKey
|
||||
// name: Authorization
|
||||
// in: header
|
||||
// description: >-
|
||||
// Enter a client token with the `Bearer` prefix, e.g. `Bearer Cxxxxxxxxxx`.
|
||||
// basicAuth:
|
||||
// type: basic
|
||||
//
|
||||
|
||||
Reference in New Issue
Block a user