126 lines
3.5 KiB
YAML
126 lines
3.5 KiB
YAML
/materials:
|
|
get:
|
|
summary: lists all materials
|
|
description: 'Auth: all, levels: read, write, maintain, dev, admin'
|
|
x-doc: returns only materials with status 10 # TODO: methods /materials/new|deleted
|
|
tags:
|
|
- /material
|
|
responses:
|
|
200:
|
|
description: all material details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: 'api.yaml#/components/schemas/Material'
|
|
401:
|
|
$ref: 'api.yaml#/components/responses/401'
|
|
500:
|
|
$ref: 'api.yaml#/components/responses/500'
|
|
|
|
/material/{id}:
|
|
parameters:
|
|
- $ref: 'api.yaml#/components/parameters/Id'
|
|
get:
|
|
summary: get material details
|
|
description: 'Auth: all, levels: read, write, maintain, dev, admin'
|
|
x-doc: status handling (accessible (only for maintain/admin))? # TODO
|
|
tags:
|
|
- /material
|
|
responses:
|
|
200:
|
|
description: material details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: 'api.yaml#/components/schemas/Material'
|
|
401:
|
|
$ref: 'api.yaml#/components/responses/401'
|
|
404:
|
|
$ref: 'api.yaml#/components/responses/404'
|
|
500:
|
|
$ref: 'api.yaml#/components/responses/500'
|
|
put:
|
|
summary: change material
|
|
description: 'Auth: basic, levels: write, maintain, dev, admin'
|
|
x-doc: status is reset to 0 on any changes
|
|
tags:
|
|
- /material
|
|
security:
|
|
- BasicAuth: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: 'api.yaml#/components/schemas/Material'
|
|
responses:
|
|
200:
|
|
description: material details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: 'api.yaml#/components/schemas/Material'
|
|
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 material
|
|
description: 'Auth: basic, levels: write, maintain, dev, admin'
|
|
x-doc: sets status to -1
|
|
tags:
|
|
- /material
|
|
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'
|
|
|
|
/material/new:
|
|
post:
|
|
summary: add material
|
|
description: 'Auth: basic, levels: write, maintain, dev, admin'
|
|
x-doc: 'Adds status: 0 automatically'
|
|
tags:
|
|
- /material
|
|
security:
|
|
- BasicAuth: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: 'api.yaml#/components/schemas/Material'
|
|
responses:
|
|
200:
|
|
description: material details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: 'api.yaml#/components/schemas/Material'
|
|
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' |