mirror of
https://gitlab.com/wgp/dougal/software.git
synced 2025-12-06 09:57:09 +00:00
Update API description
This commit is contained in:
@@ -216,6 +216,30 @@ components:
|
||||
pattern: "(([^\\s,;:]+)(\\s*[,;:\\s]\\s*)?)+"
|
||||
example: "line,point,tstamp"
|
||||
|
||||
CSVDelimiter:
|
||||
description: Delimiter value to use in CSV requests or responses.
|
||||
name: delimiter
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
example: ","
|
||||
|
||||
CSVFields:
|
||||
description: Fields to return in CSV responses.
|
||||
name: fields
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
example: timestamp,sequence,point,text
|
||||
|
||||
CSVHeader:
|
||||
description: Whether to return the header row in CSV responses. It defaults to **`true`**. If present, any value other than `true` or `1` represent **`false`**.
|
||||
name: header
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
example: f
|
||||
|
||||
Unique:
|
||||
description: |
|
||||
Return unique results. Any value at all represents `true`.
|
||||
@@ -1317,6 +1341,9 @@ paths:
|
||||
- CookieAuthGuest: []
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/Project"
|
||||
- $ref: "#/components/parameters/CSVDelimiter"
|
||||
- $ref: "#/components/parameters/CSVFields"
|
||||
- $ref: "#/components/parameters/CSVHeader"
|
||||
responses:
|
||||
"200":
|
||||
description: List of project events
|
||||
@@ -1336,6 +1363,23 @@ paths:
|
||||
application/vnd.seis+json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/SeisExport"
|
||||
|
||||
text/csv:
|
||||
schema:
|
||||
type: string
|
||||
contentMediaType: text/csv
|
||||
description: |
|
||||
A CSV representation of the event log, with the following columns:
|
||||
|
||||
* `timestamp`: Event timestamp, in UTC.
|
||||
* `sequence`: Sequence number, if applicable.
|
||||
* `point`: Point number, if applicable.
|
||||
* `text`: Event text. May contain newlines and [Markdown](https://daringfireball.net/projects/markdown/syntax "Markdown syntax"). formatting.
|
||||
* `labels`: Labels associated with the event. Multiple labels are separated by `;` *(be careful about using `;` as a field separator!)*
|
||||
* `latitude`: Event latitude, if the event has a Point geometry.
|
||||
* `longitude`: Event longitude, if the event has a Point geometry.
|
||||
* `id`: Event ID internal to Dougal.
|
||||
|
||||
"401":
|
||||
$ref: "#/components/responses/401"
|
||||
post:
|
||||
|
||||
Reference in New Issue
Block a user