kopia lustrzana https://github.com/OpenDroneMap/NodeODM
Fixed swagger /info declaration
rodzic
49d6551e74
commit
a50cb80bbe
|
@ -72,6 +72,11 @@ _required_|Current version|string
|
|||
|===
|
||||
|
||||
|
||||
==== Tags
|
||||
|
||||
* server
|
||||
|
||||
|
||||
[[_options_get]]
|
||||
=== GET /options
|
||||
|
||||
|
@ -106,6 +111,11 @@ _required_|Default value of this option|string
|
|||
|===
|
||||
|
||||
|
||||
==== Tags
|
||||
|
||||
* server
|
||||
|
||||
|
||||
[[_task_cancel_post]]
|
||||
=== POST /task/cancel
|
||||
|
||||
|
@ -178,6 +188,11 @@ _required_|UUID of the newly created task|string
|
|||
* `multipart/form-data`
|
||||
|
||||
|
||||
==== Tags
|
||||
|
||||
* task
|
||||
|
||||
|
||||
[[_task_remove_post]]
|
||||
=== POST /task/remove
|
||||
|
||||
|
@ -259,6 +274,16 @@ _required_|UUID of the task|string|
|
|||
|===
|
||||
|
||||
|
||||
==== Produces
|
||||
|
||||
* `application/zip`
|
||||
|
||||
|
||||
==== Tags
|
||||
|
||||
* task
|
||||
|
||||
|
||||
[[_task_uuid_info_get]]
|
||||
=== GET /task/{uuid}/info
|
||||
|
||||
|
@ -320,6 +345,11 @@ _required_|Value (example: 9)|string
|
|||
|===
|
||||
|
||||
|
||||
==== Tags
|
||||
|
||||
* task
|
||||
|
||||
|
||||
[[_task_uuid_output_get]]
|
||||
=== GET /task/{uuid}/output
|
||||
|
||||
|
@ -349,6 +379,11 @@ _optional_|Optional line number that the console output should be truncated from
|
|||
|===
|
||||
|
||||
|
||||
==== Tags
|
||||
|
||||
* task
|
||||
|
||||
|
||||
|
||||
|
||||
[[_definitions]]
|
||||
|
@ -374,7 +409,7 @@ _required_|Description of the error|string
|
|||
|*error* +
|
||||
_optional_|Error message if an error occured|string
|
||||
|*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
11
index.js
11
index.js
|
@ -75,6 +75,7 @@ let server;
|
|||
* /task/new:
|
||||
* post:
|
||||
* description: Creates a new task and places it at the end of the processing queue
|
||||
* tags: [task]
|
||||
* consumes:
|
||||
* - multipart/form-data
|
||||
* parameters:
|
||||
|
@ -183,6 +184,7 @@ let getTaskFromUuid = (req, res, next) => {
|
|||
* /task/{uuid}/info:
|
||||
* 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.
|
||||
* tags: [task]
|
||||
* parameters:
|
||||
* -
|
||||
* name: uuid
|
||||
|
@ -243,6 +245,7 @@ app.get('/task/:uuid/info', getTaskFromUuid, (req, res) => {
|
|||
* /task/{uuid}/output:
|
||||
* get:
|
||||
* description: Retrieves the console output of the OpenDroneMap's process. Useful for monitoring execution and to provide updates to the user.
|
||||
* tags: [task]
|
||||
* parameters:
|
||||
* -
|
||||
* name: uuid
|
||||
|
@ -275,6 +278,8 @@ app.get('/task/:uuid/output', getTaskFromUuid, (req, res) => {
|
|||
* /task/{uuid}/download/{asset}:
|
||||
* get:
|
||||
* description: Retrieves an asset (the output of OpenDroneMap's processing) associated with a task
|
||||
* tags: [task]
|
||||
* produces: [application/zip]
|
||||
* parameters:
|
||||
* - name: uuid
|
||||
* in: path
|
||||
|
@ -325,7 +330,7 @@ app.get('/task/:uuid/download/:asset', getTaskFromUuid, (req, res) => {
|
|||
* properties:
|
||||
* success:
|
||||
* type: boolean
|
||||
* description: true if the command succeeded, false otherwise.
|
||||
* description: true if the command succeeded, false otherwise
|
||||
* error:
|
||||
* type: string
|
||||
* description: Error message if an error occured
|
||||
|
@ -412,6 +417,7 @@ app.post('/task/restart', uuidCheck, (req, res) => {
|
|||
* /options:
|
||||
* get:
|
||||
* description: Retrieves the command line options that can be passed to process a task
|
||||
* tags: [server]
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Options
|
||||
|
@ -454,6 +460,7 @@ app.get('/options', (req, res) => {
|
|||
* /info:
|
||||
* get:
|
||||
* description: Retrieves information about this node
|
||||
* tags: [server]
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Info
|
||||
|
@ -471,7 +478,7 @@ app.get('/options', (req, res) => {
|
|||
app.get('/info', (req, res) => {
|
||||
res.json({
|
||||
version: packageJson.version,
|
||||
currentTaskQueue: taskManager.getQueueCount()
|
||||
taskQueueCount: taskManager.getQueueCount()
|
||||
});
|
||||
});
|
||||
|
||||
|
|
Ładowanie…
Reference in New Issue