kopia lustrzana https://github.com/OpenDroneMap/NodeODM
Fixed some items in the docs
rodzic
3b4554b056
commit
98ff96e928
|
@ -56,11 +56,11 @@ Retrieves the command line options that can be passed to process a task
|
||||||
[options="header", cols=".^2,.^14,.^4"]
|
[options="header", cols=".^2,.^14,.^4"]
|
||||||
|===
|
|===
|
||||||
|HTTP Code|Description|Schema
|
|HTTP Code|Description|Schema
|
||||||
|*200*|Options|< <<_getoptions_get_response_200,Response 200>> > array
|
|*200*|Options|< <<_option,Option>> > array
|
||||||
|===
|
|===
|
||||||
|
|
||||||
[[_getoptions_get_response_200]]
|
[[_option]]
|
||||||
*Response 200*
|
*Option*
|
||||||
|
|
||||||
[options="header", cols=".^3,.^11,.^4"]
|
[options="header", cols=".^3,.^11,.^4"]
|
||||||
|===
|
|===
|
||||||
|
@ -253,30 +253,30 @@ _required_|UUID of the task|string|
|
||||||
[options="header", cols=".^2,.^14,.^4"]
|
[options="header", cols=".^2,.^14,.^4"]
|
||||||
|===
|
|===
|
||||||
|HTTP Code|Description|Schema
|
|HTTP Code|Description|Schema
|
||||||
|*200*|Task Information|<<_task_uuid_info_get_response_200,Response 200>>
|
|*200*|Task Information|<<_taskinfo,TaskInfo>>
|
||||||
|*default*|Error|<<_error,Error>>
|
|*default*|Error|<<_error,Error>>
|
||||||
|===
|
|===
|
||||||
|
|
||||||
[[_task_uuid_info_get_response_200]]
|
[[_taskinfo]]
|
||||||
*Response 200*
|
*TaskInfo*
|
||||||
|
|
||||||
[options="header", cols=".^3,.^11,.^4"]
|
[options="header", cols=".^3,.^11,.^4"]
|
||||||
|===
|
|===
|
||||||
|Name|Description|Schema
|
|Name|Description|Schema
|
||||||
|*dateCreated* +
|
|*dateCreated* +
|
||||||
_optional_|Timestamp|integer
|
_required_|Timestamp|integer
|
||||||
|*imagesCount* +
|
|*imagesCount* +
|
||||||
_optional_|Number of images|integer
|
_required_|Number of images|integer
|
||||||
|*name* +
|
|*name* +
|
||||||
_optional_|Name|string
|
_required_|Name|string
|
||||||
|*options* +
|
|*options* +
|
||||||
_optional_|List of options used to process this task|< <<_task_uuid_info_get_options,options>> > array
|
_required_|List of options used to process this task|< <<_task_uuid_info_get_options,options>> > array
|
||||||
|*processingTime* +
|
|*processingTime* +
|
||||||
_optional_|Milliseconds that have elapsed since the task started being processed.|integer
|
_required_|Milliseconds that have elapsed since the task started being processed.|integer
|
||||||
|*status* +
|
|*status* +
|
||||||
_optional_|Status code (10 = QUEUED, 20 = RUNNING, 30 = FAILED, 40 = COMPLETED, 50 = CANCELED)|integer
|
_required_|Status code (10 = QUEUED, 20 = RUNNING, 30 = FAILED, 40 = COMPLETED, 50 = CANCELED)|integer
|
||||||
|*uuid* +
|
|*uuid* +
|
||||||
_optional_|UUID|string
|
_required_|UUID|string
|
||||||
|===
|
|===
|
||||||
|
|
||||||
[[_task_uuid_info_get_options]]
|
[[_task_uuid_info_get_options]]
|
||||||
|
@ -286,9 +286,9 @@ _optional_|UUID|string
|
||||||
|===
|
|===
|
||||||
|Name|Description|Schema
|
|Name|Description|Schema
|
||||||
|*name* +
|
|*name* +
|
||||||
_optional_|Option name (example: "odm_meshing-octreeDepth")|string
|
_required_|Option name (example: "odm_meshing-octreeDepth")|string
|
||||||
|*value* +
|
|*value* +
|
||||||
_optional_|Value (example: 9)|string
|
_required_|Value (example: 9)|string
|
||||||
|===
|
|===
|
||||||
|
|
||||||
|
|
||||||
|
|
File diff suppressed because one or more lines are too long
4
index.js
4
index.js
|
@ -192,7 +192,9 @@ let getTaskFromUuid = (req, res, next) => {
|
||||||
* 200:
|
* 200:
|
||||||
* description: Task Information
|
* description: Task Information
|
||||||
* schema:
|
* schema:
|
||||||
|
* title: TaskInfo
|
||||||
* type: object
|
* type: object
|
||||||
|
* required: [uuid, name, dateCreated, processingTime, status, options, imagesCount]
|
||||||
* properties:
|
* properties:
|
||||||
* uuid:
|
* uuid:
|
||||||
* type: string
|
* type: string
|
||||||
|
@ -215,6 +217,7 @@ let getTaskFromUuid = (req, res, next) => {
|
||||||
* description: List of options used to process this task
|
* description: List of options used to process this task
|
||||||
* items:
|
* items:
|
||||||
* type: object
|
* type: object
|
||||||
|
* required: [name, value]
|
||||||
* properties:
|
* properties:
|
||||||
* name:
|
* name:
|
||||||
* type: string
|
* type: string
|
||||||
|
@ -412,6 +415,7 @@ app.post('/task/restart', uuidCheck, (req, res) => {
|
||||||
* schema:
|
* schema:
|
||||||
* type: array
|
* type: array
|
||||||
* items:
|
* items:
|
||||||
|
* title: Option
|
||||||
* type: object
|
* type: object
|
||||||
* properties:
|
* properties:
|
||||||
* name:
|
* name:
|
||||||
|
|
Ładowanie…
Reference in New Issue