banana/definma-api
Archived
2
Fork 0
Code Releases Activity

finished /template methods

Browse Source
This commit is contained in:
VLE2FE
2020-05-04 15:48:07 +02:00
parent 5f20afcf04
commit af071a9445
16 changed files with 898 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
api/api.yaml
View File

@ -48,7 +48,7 @@ tags:
- name: /material
- name: /condition
- name: /measurement
- name: /templates
- name: /template
- name: /model
- name: /user

4
api/material.yaml
View File

@ -70,7 +70,7 @@
500:
$ref: 'api.yaml#/components/responses/500'
delete:
summary: TODO delete material
summary: delete material
description: 'Auth: basic, levels: write, maintain, dev, admin'
tags:
- /material
@ -90,7 +90,7 @@
/material/new:
post:
summary: TODO add material
summary: add material
description: 'Auth: basic, levels: write, maintain, dev, admin'
tags:
- /material

1
api/parameters.yaml
View File

@ -7,6 +7,7 @@ Id:
example: 5ea0450ed851c30a90e70894
Name:
name: name
description: has to be URL encoded
in: path
required: true
schema:

61
api/template.yaml
View File

@ -1,9 +1,9 @@
/template/treatments:
get:
summary: TODO all available treatment methods
summary: all available treatment methods
description: 'Auth: basic, levels: read, write, maintain, dev, admin'
tags:
- /templates
- /template
security:
- BasicAuth: []
responses:
@ -16,23 +16,26 @@
items:
$ref: 'api.yaml#/components/schemas/Template'
example:
_id: 5ea0450ed851c30a90e70894
name: heat aging
parameters:
- name: method
range:
- copper
values:
- copper
- hot air
401:
$ref: 'api.yaml#/components/responses/401'
500:
$ref: 'api.yaml#/components/responses/500'
/templates/treatment/{name}:
/template/treatment/{name}:
parameters:
- $ref: 'api.yaml#/components/parameters/Name'
get:
summary: TODO treatment method details
summary: treatment method details
description: 'Auth: basic, levels: read, write, maintain, admin'
tags:
- /templates
- /template
security:
- BasicAuth: []
responses:
@ -44,13 +47,14 @@
allOf:
- $ref: 'api.yaml#/components/schemas/Template'
example:
_id: 5ea0450ed851c30a90e70894
name: heat aging
parameters:
- name: method
range:
- copper
400:
$ref: 'api.yaml#/components/responses/400'
values:
- copper
- hot air
401:
$ref: 'api.yaml#/components/responses/401'
404:
@ -58,10 +62,10 @@
500:
$ref: 'api.yaml#/components/responses/500'
put:
summary: TODO add/change treatment method
summary: add/change treatment method
description: 'Auth: basic, levels: maintain, admin'
tags:
- /templates
- /template
security:
- BasicAuth: []
requestBody:
@ -76,7 +80,9 @@
parameters:
- name: method
range:
- copper
values:
- copper
- hot air
responses:
200:
description: treatment details
@ -86,11 +92,14 @@
allOf:
- $ref: 'api.yaml#/components/schemas/Template'
example:
_id: 5ea0450ed851c30a90e70894
name: heat aging
parameters:
- name: method
range:
- copper
values:
- copper
- hot air
400:
$ref: 'api.yaml#/components/responses/400'
401:
@ -102,10 +111,10 @@
500:
$ref: 'api.yaml#/components/responses/500'
delete:
summary: TODO delete treatment method
summary: delete treatment method
description: 'Auth: basic, levels: maintain, admin'
tags:
- /templates
- /template
security:
- BasicAuth: []
responses:
@ -123,10 +132,10 @@
$ref: 'api.yaml#/components/responses/500'
/template/measurements:
get:
summary: TODO all available measurement methods
summary: all available measurement methods
description: 'Auth: basic, levels: read, write, maintain, dev, admin'
tags:
- /templates
- /template
security:
- BasicAuth: []
responses:
@ -139,6 +148,7 @@
items:
$ref: 'api.yaml#/components/schemas/Template'
example:
_id: 5ea0450ed851c30a90e70894
name: humidity
parameters:
- name: kf
@ -149,14 +159,14 @@
$ref: 'api.yaml#/components/responses/401'
500:
$ref: 'api.yaml#/components/responses/500'
/templates/measurement/{name}:
/template/measurement/{name}:
parameters:
- $ref: 'api.yaml#/components/parameters/Name'
get:
summary: TODO measurement method details
summary: measurement method details
description: 'Auth: basic, levels: read, write, maintain, admin'
tags:
- /templates
- /template
security:
- BasicAuth: []
responses:
@ -168,6 +178,7 @@
allOf:
- $ref: 'api.yaml#/components/schemas/Template'
example:
_id: 5ea0450ed851c30a90e70894
name: humidity
parameters:
- name: kf
@ -183,10 +194,10 @@
500:
$ref: 'api.yaml#/components/responses/500'
put:
summary: TODO add/change measurement method
summary: add/change measurement method
description: 'Auth: basic, levels: maintain, admin'
tags:
- /templates
- /template
security:
- BasicAuth: []
requestBody:
@ -197,6 +208,7 @@
allOf:
- $ref: 'api.yaml#/components/schemas/Template'
example:
_id: 5ea0450ed851c30a90e70894
name: humidity
parameters:
- name: kf
@ -212,6 +224,7 @@
allOf:
- $ref: 'api.yaml#/components/schemas/Template'
example:
_id: 5ea0450ed851c30a90e70894
name: humidity
parameters:
- name: kf
@ -229,10 +242,10 @@
500:
$ref: 'api.yaml#/components/responses/500'
delete:
summary: TODO delete measurement method
summary: delete measurement method
description: 'Auth: basic, levels: maintain, admin'
tags:
- /templates
- /template
security:
- BasicAuth: []
responses: