109 lines
3.0 KiB
YAML
109 lines
3.0 KiB
YAML
/measurement/{id}:
|
|
parameters:
|
|
- $ref: 'api.yaml#/components/parameters/Id'
|
|
get:
|
|
summary: measurement values by id
|
|
description: 'Auth: all, levels: read, write, maintain, dev, admin'
|
|
x-doc: status handling (accessible (only for maintain/admin))? # TODO after decision
|
|
tags:
|
|
- /measurement
|
|
responses:
|
|
200:
|
|
description: measurement details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: 'api.yaml#/components/schemas/Measurement'
|
|
400:
|
|
$ref: 'api.yaml#/components/responses/400'
|
|
401:
|
|
$ref: 'api.yaml#/components/responses/401'
|
|
404:
|
|
$ref: 'api.yaml#/components/responses/404'
|
|
500:
|
|
$ref: 'api.yaml#/components/responses/500'
|
|
put:
|
|
summary: change measurement
|
|
description: 'Auth: basic, levels: write, maintain, dev, admin'
|
|
x-doc: status is reset to 0 on any changes
|
|
tags:
|
|
- /measurement
|
|
security:
|
|
- BasicAuth: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
properties:
|
|
values:
|
|
type: object
|
|
responses:
|
|
200:
|
|
description: measurement details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: 'api.yaml#/components/schemas/Measurement'
|
|
400:
|
|
$ref: 'api.yaml#/components/responses/400'
|
|
401:
|
|
$ref: 'api.yaml#/components/responses/401'
|
|
403:
|
|
$ref: 'api.yaml#/components/responses/403'
|
|
404:
|
|
$ref: 'api.yaml#/components/responses/404'
|
|
500:
|
|
$ref: 'api.yaml#/components/responses/500'
|
|
delete:
|
|
summary: delete measurement
|
|
description: 'Auth: basic, levels: write, maintain, dev, admin'
|
|
x-doc: sets status to -1
|
|
tags:
|
|
- /measurement
|
|
security:
|
|
- BasicAuth: []
|
|
responses:
|
|
200:
|
|
$ref: 'api.yaml#/components/responses/Ok'
|
|
400:
|
|
$ref: 'api.yaml#/components/responses/400'
|
|
401:
|
|
$ref: 'api.yaml#/components/responses/401'
|
|
403:
|
|
$ref: 'api.yaml#/components/responses/403'
|
|
404:
|
|
$ref: 'api.yaml#/components/responses/404'
|
|
500:
|
|
$ref: 'api.yaml#/components/responses/500'
|
|
|
|
/measurement/new:
|
|
post:
|
|
summary: add measurement
|
|
description: 'Auth: basic, levels: write, maintain, dev, admin'
|
|
x-doc: 'Adds status: 0 automatically'
|
|
tags:
|
|
- /measurement
|
|
security:
|
|
- BasicAuth: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: 'api.yaml#/components/schemas/Measurement'
|
|
responses:
|
|
200:
|
|
description: measurement details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: 'api.yaml#/components/schemas/Measurement'
|
|
400:
|
|
$ref: 'api.yaml#/components/responses/400'
|
|
401:
|
|
$ref: 'api.yaml#/components/responses/401'
|
|
403:
|
|
$ref: 'api.yaml#/components/responses/403'
|
|
500:
|
|
$ref: 'api.yaml#/components/responses/500' |