definma-api/api/material.yaml

/materials:
  get:
    summary: lists all materials
    description: 'Auth: all, levels: read, write, maintain, dev, admin'
    x-doc: returns only materials with status 10
    tags:
      - /material
    parameters:
      - name: status
        description: 'values: validated|new|all, defaults to validated'
        in: query
        schema:
          type: string
        example: all
    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'

/materials/{state}:
  parameters:
    - $ref: 'api.yaml#/components/parameters/State'
  get:
    summary: lists all new/deleted materials
    description: 'Auth: basic, levels: maintain, admin'
    x-doc: returns materials with status 0/-1
    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: deleted samples are available only for maintain/admin
    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, deleted samples cannot be changed
    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/restore/{id}:
  parameters:
    - $ref: 'api.yaml#/components/parameters/Id'
  put:
    summary: restore material
    description: 'Auth: basic, levels: maintain, admin'
    x-doc: status is set to 0
    tags:
      - /material
    security:
      - BasicAuth: []
    responses:
      200:
        $ref: 'api.yaml#/components/responses/Ok'
      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/validate/{id}:
  parameters:
    - $ref: 'api.yaml#/components/parameters/Id'
  put:
    summary: restore material
    description: 'Auth: basic, levels: maintain, admin'
    x-doc: status is set to 10
    tags:
      - /material
    security:
      - BasicAuth: []
    responses:
      200:
        $ref: 'api.yaml#/components/responses/Ok'
      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'

/material/groups:
  get:
    summary: list all existing material groups
    description: 'Auth: all, levels: read, write, maintain, dev, admin'
    tags:
      - /material
    responses:
      200:
        description: all material groups
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
                example: PA66
      401:
        $ref: 'api.yaml#/components/responses/401'
      403:
        $ref: 'api.yaml#/components/responses/403'
      500:
        $ref: 'api.yaml#/components/responses/500'

/material/suppliers:
  get:
    summary: list all existing material suppliers
    description: 'Auth: all, levels: read, write, maintain, dev, admin'
    tags:
      - /material
    responses:
      200:
        description: all material suppliers
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
                example: BASF
      401:
        $ref: 'api.yaml#/components/responses/401'
      403:
        $ref: 'api.yaml#/components/responses/403'
      500:
        $ref: 'api.yaml#/components/responses/500'