250 lines
6.8 KiB
YAML
250 lines
6.8 KiB
YAML
/template/treatments:
|
|
get:
|
|
summary: TODO all available treatment methods
|
|
description: 'Auth: basic, levels: read, write, maintain, dev, admin'
|
|
tags:
|
|
- /templates
|
|
security:
|
|
- BasicAuth: []
|
|
responses:
|
|
200:
|
|
description: list of treatments
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: 'api.yaml#/components/schemas/Template'
|
|
example:
|
|
name: heat aging
|
|
parameters:
|
|
- name: method
|
|
range:
|
|
- copper
|
|
401:
|
|
$ref: 'api.yaml#/components/responses/401'
|
|
500:
|
|
$ref: 'api.yaml#/components/responses/500'
|
|
/templates/treatment/{name}:
|
|
parameters:
|
|
- $ref: 'api.yaml#/components/parameters/Name'
|
|
get:
|
|
summary: TODO treatment method details
|
|
description: 'Auth: basic, levels: read, write, maintain, admin'
|
|
tags:
|
|
- /templates
|
|
security:
|
|
- BasicAuth: []
|
|
responses:
|
|
200:
|
|
description: treatment details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- $ref: 'api.yaml#/components/schemas/Template'
|
|
example:
|
|
name: heat aging
|
|
parameters:
|
|
- name: method
|
|
range:
|
|
- copper
|
|
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: TODO add/change treatment method
|
|
description: 'Auth: basic, levels: maintain, admin'
|
|
tags:
|
|
- /templates
|
|
security:
|
|
- BasicAuth: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- $ref: 'api.yaml#/components/schemas/Template'
|
|
example:
|
|
name: heat aging
|
|
parameters:
|
|
- name: method
|
|
range:
|
|
- copper
|
|
responses:
|
|
200:
|
|
description: treatment details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- $ref: 'api.yaml#/components/schemas/Template'
|
|
example:
|
|
name: heat aging
|
|
parameters:
|
|
- name: method
|
|
range:
|
|
- copper
|
|
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: TODO delete treatment method
|
|
description: 'Auth: basic, levels: maintain, admin'
|
|
tags:
|
|
- /templates
|
|
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'
|
|
/template/measurements:
|
|
get:
|
|
summary: TODO all available measurement methods
|
|
description: 'Auth: basic, levels: read, write, maintain, dev, admin'
|
|
tags:
|
|
- /templates
|
|
security:
|
|
- BasicAuth: []
|
|
responses:
|
|
200:
|
|
description: list of measurement methods
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: 'api.yaml#/components/schemas/Template'
|
|
example:
|
|
name: humidity
|
|
parameters:
|
|
- name: kf
|
|
range:
|
|
min: 0
|
|
max: 2
|
|
401:
|
|
$ref: 'api.yaml#/components/responses/401'
|
|
500:
|
|
$ref: 'api.yaml#/components/responses/500'
|
|
/templates/measurement/{name}:
|
|
parameters:
|
|
- $ref: 'api.yaml#/components/parameters/Name'
|
|
get:
|
|
summary: TODO measurement method details
|
|
description: 'Auth: basic, levels: read, write, maintain, admin'
|
|
tags:
|
|
- /templates
|
|
security:
|
|
- BasicAuth: []
|
|
responses:
|
|
200:
|
|
description: measurement details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- $ref: 'api.yaml#/components/schemas/Template'
|
|
example:
|
|
name: humidity
|
|
parameters:
|
|
- name: kf
|
|
range:
|
|
min: 0
|
|
max: 2
|
|
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: TODO add/change measurement method
|
|
description: 'Auth: basic, levels: maintain, admin'
|
|
tags:
|
|
- /templates
|
|
security:
|
|
- BasicAuth: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- $ref: 'api.yaml#/components/schemas/Template'
|
|
example:
|
|
name: humidity
|
|
parameters:
|
|
- name: kf
|
|
range:
|
|
min: 0
|
|
max: 2
|
|
responses:
|
|
200:
|
|
description: measurement details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- $ref: 'api.yaml#/components/schemas/Template'
|
|
example:
|
|
name: humidity
|
|
parameters:
|
|
- name: kf
|
|
range:
|
|
min: 0
|
|
max: 2
|
|
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: TODO delete measurement method
|
|
description: 'Auth: basic, levels: maintain, admin'
|
|
tags:
|
|
- /templates
|
|
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' |