Update API specification

This commit is contained in:
D. Berge
2023-10-29 11:51:18 +01:00
parent 1ade981902
commit 54fe18035f

View File

@@ -216,6 +216,26 @@ components:
pattern: "(([^\\s,;:]+)(\\s*[,;:\\s]\\s*)?)+"
example: "line,point,tstamp"
QueryMime:
name: mime
description: |
Ask for the representation of the requested resource to be provided in the indicated MIME type. Overrides the [`Accept`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept) request header values (if any).
Note that the server is not obliged to honour the requested type and a default (usually `application/json`) might be provided instead. Always check the response's [`Content-Type`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type) header.
in: query
schema:
type: string
QueryFilename:
name: filename
description: |
Cause the [`Content-Disposition`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition) response header to be set and suggest a file name to download as.
Note that the [`Content-Type`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type) response header is not affected by this parameter.
in: query
schema:
type: string
CSVDelimiter:
description: Delimiter value to use in CSV requests or responses.
name: delimiter
@@ -1394,6 +1414,8 @@ paths:
- $ref: "#/components/parameters/CSVDelimiter"
- $ref: "#/components/parameters/CSVFields"
- $ref: "#/components/parameters/CSVHeader"
- $ref: "#/components/parameters/QueryMime"
- $ref: "#/components/parameters/QueryFilename"
responses:
"200":
description: List of project events