Fixed swagger /info declaration

pull/1/head
Piero Toffanin 2016-09-20 17:07:32 -04:00
rodzic 49d6551e74
commit a50cb80bbe
3 zmienionych plików z 46 dodań i 4 usunięć

Wyświetl plik

@ -72,6 +72,11 @@ _required_|Current version|string
|=== |===
==== Tags
* server
[[_options_get]] [[_options_get]]
=== GET /options === GET /options
@ -106,6 +111,11 @@ _required_|Default value of this option|string
|=== |===
==== Tags
* server
[[_task_cancel_post]] [[_task_cancel_post]]
=== POST /task/cancel === POST /task/cancel
@ -178,6 +188,11 @@ _required_|UUID of the newly created task|string
* `multipart/form-data` * `multipart/form-data`
==== Tags
* task
[[_task_remove_post]] [[_task_remove_post]]
=== POST /task/remove === POST /task/remove
@ -259,6 +274,16 @@ _required_|UUID of the task|string|
|=== |===
==== Produces
* `application/zip`
==== Tags
* task
[[_task_uuid_info_get]] [[_task_uuid_info_get]]
=== GET /task/{uuid}/info === GET /task/{uuid}/info
@ -320,6 +345,11 @@ _required_|Value (example: 9)|string
|=== |===
==== Tags
* task
[[_task_uuid_output_get]] [[_task_uuid_output_get]]
=== GET /task/{uuid}/output === GET /task/{uuid}/output
@ -349,6 +379,11 @@ _optional_|Optional line number that the console output should be truncated from
|=== |===
==== Tags
* task
[[_definitions]] [[_definitions]]
@ -374,7 +409,7 @@ _required_|Description of the error|string
|*error* + |*error* +
_optional_|Error message if an error occured|string _optional_|Error message if an error occured|string
|*success* + |*success* +
_required_|true if the command succeeded, false otherwise.|boolean _required_|true if the command succeeded, false otherwise|boolean
|=== |===

File diff suppressed because one or more lines are too long

Wyświetl plik

@ -75,6 +75,7 @@ let server;
* /task/new: * /task/new:
* post: * post:
* description: Creates a new task and places it at the end of the processing queue * description: Creates a new task and places it at the end of the processing queue
* tags: [task]
* consumes: * consumes:
* - multipart/form-data * - multipart/form-data
* parameters: * parameters:
@ -183,6 +184,7 @@ let getTaskFromUuid = (req, res, next) => {
* /task/{uuid}/info: * /task/{uuid}/info:
* get: * get:
* description: Gets information about this task, such as name, creation date, processing time, status, command line options and number of images being processed. See schema definition for a full list. * description: Gets information about this task, such as name, creation date, processing time, status, command line options and number of images being processed. See schema definition for a full list.
* tags: [task]
* parameters: * parameters:
* - * -
* name: uuid * name: uuid
@ -243,6 +245,7 @@ app.get('/task/:uuid/info', getTaskFromUuid, (req, res) => {
* /task/{uuid}/output: * /task/{uuid}/output:
* get: * get:
* description: Retrieves the console output of the OpenDroneMap's process. Useful for monitoring execution and to provide updates to the user. * description: Retrieves the console output of the OpenDroneMap's process. Useful for monitoring execution and to provide updates to the user.
* tags: [task]
* parameters: * parameters:
* - * -
* name: uuid * name: uuid
@ -275,6 +278,8 @@ app.get('/task/:uuid/output', getTaskFromUuid, (req, res) => {
* /task/{uuid}/download/{asset}: * /task/{uuid}/download/{asset}:
* get: * get:
* description: Retrieves an asset (the output of OpenDroneMap's processing) associated with a task * description: Retrieves an asset (the output of OpenDroneMap's processing) associated with a task
* tags: [task]
* produces: [application/zip]
* parameters: * parameters:
* - name: uuid * - name: uuid
* in: path * in: path
@ -325,7 +330,7 @@ app.get('/task/:uuid/download/:asset', getTaskFromUuid, (req, res) => {
* properties: * properties:
* success: * success:
* type: boolean * type: boolean
* description: true if the command succeeded, false otherwise. * description: true if the command succeeded, false otherwise
* error: * error:
* type: string * type: string
* description: Error message if an error occured * description: Error message if an error occured
@ -412,6 +417,7 @@ app.post('/task/restart', uuidCheck, (req, res) => {
* /options: * /options:
* get: * get:
* description: Retrieves the command line options that can be passed to process a task * description: Retrieves the command line options that can be passed to process a task
* tags: [server]
* responses: * responses:
* 200: * 200:
* description: Options * description: Options
@ -454,6 +460,7 @@ app.get('/options', (req, res) => {
* /info: * /info:
* get: * get:
* description: Retrieves information about this node * description: Retrieves information about this node
* tags: [server]
* responses: * responses:
* 200: * 200:
* description: Info * description: Info
@ -471,7 +478,7 @@ app.get('/options', (req, res) => {
app.get('/info', (req, res) => { app.get('/info', (req, res) => {
res.json({ res.json({
version: packageJson.version, version: packageJson.version,
currentTaskQueue: taskManager.getQueueCount() taskQueueCount: taskManager.getQueueCount()
}); });
}); });