Aaltronav/dougal-software
1
0
Fork 0
mirror of https://gitlab.com/wgp/dougal/software.git synced 2025-12-06 10:37:07 +00:00
Code Issues Packages Projects Releases Activity

Update planner endpoint documentation

Browse Source
This commit is contained in:
D. Berge
2023-10-23 14:57:27 +02:00
parent 2d1e1e9532
commit 5065d62443
1 changed files with 49 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
lib/www/server/spec/openapi.yaml
View File

@@ -1232,9 +1232,55 @@ paths:
content:
application/json:
schema:
type: object
properties:
remarks:
type: string
description: Planner remarks
sequences:
type: array
items:
$ref: "#/components/schemas/PlannedSequence"
text/csv:
schema:
type: string
format: csv
description: |
Returns a CSV response containing one row for each planned sequence, with the following columns:
* `sequence`: Sequence number
* `line`: Line number
* `fsp`: First shotpoint
* `lsp`: Last shotpoint
* `ts0`: Estimated timestamp of the first shotpoint
* `ts1`: Estimated timestamp of the last shotpoint
* `name`: Line name
* `remarks`: Arbitrary comments
* `num_points`: Number of shotpoints
* `duration`: Estimated duration in seconds
* `length`: Line length in metres
* `azimuth`: Line azimuth
* `lon0`: Longitude of the first shotpoint
* `lat0`: Latitude of the first shotpoint
* `lon1` Longitude of the last shotpoint
* `lat1`: Latitude of the last shotpoint
example: |
"sequence","line","fsp","lsp","ts0","ts1","name","remarks","num_points","duration","length","azimuth","lon0","lat0","lon1","lat1"
81,5162,2422,1158,"2023-10-22T11:09:24.912Z","2023-10-22T12:56:03.395Z","2051621081S00000","",633,6398,15799.988472147348,26.4703415983101,2.474872,59.086695,2.596266,59.214146
82,5178,2444,1146,"2023-10-22T12:56:03.000Z","2023-10-22T14:45:33.607Z","2051781082S00000","",650,6570,16225.02094944685,26.470137885560813,2.469632,59.085264,2.594277,59.216147
text/html:
schema:
type: string
format: html
description: |
An HTML representation of the plan.
application/pdf:
schema:
type: string
contentMediaType: application/pdf
description: |
A PDF representation of the plan.
post:
description: Add a new sequence to the plan.