Updated docs with token info

pull/63/head
Piero Toffanin 2018-12-15 15:28:29 -05:00
rodzic 2d7944c18b
commit 787571e6a0
3 zmienionych plików z 35 dodań i 1 usunięć

Wyświetl plik

@ -50,6 +50,16 @@ _Schemes_ : HTTP
Retrieves information about this node
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*token* +
_optional_|Token required for authentication (when authentication is required).|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]
@ -95,6 +105,16 @@ _required_|Current API version|string
Retrieves the command line options that can be passed to process a task
==== Parameters
[options="header", cols=".^2,.^3,.^9,.^4,.^2"]
|===
|Type|Name|Description|Schema|Default
|*Query*|*token* +
_optional_|Token required for authentication (when authentication is required).|string|
|===
==== Responses
[options="header", cols=".^2,.^14,.^4"]

File diff suppressed because one or more lines are too long

Wyświetl plik

@ -610,6 +610,13 @@ app.post('/task/restart', urlEncodedBodyParser, authCheck, uuidCheck, (req, res,
* /options:
* get:
* description: Retrieves the command line options that can be passed to process a task
* parameters:
* -
* name: token
* in: query
* description: 'Token required for authentication (when authentication is required).'
* required: false
* type: string
* tags: [server]
* responses:
* 200:
@ -653,6 +660,13 @@ app.get('/options', authCheck, (req, res) => {
* /info:
* get:
* description: Retrieves information about this node
* parameters:
* -
* name: token
* in: query
* description: 'Token required for authentication (when authentication is required).'
* required: false
* type: string
* tags: [server]
* responses:
* 200: