definma-api/api/measurement.yaml

/measurement/{id}:
  parameters:
    - $ref: 'api.yaml#/components/parameters/Id'
  get:
    summary: measurement values by id
    description: 'Auth: all, levels: read, write, dev, admin, spectral data can only be accessed by dev and admin'
    x-doc: deleted samples are available only for dev/admin
    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, dev, admin'
    x-doc: status is reset to 0 on any changes, deleted measurements cannot be edited
    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, 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/sample/{id}:
  parameters:
    - $ref: 'api.yaml#/components/parameters/Id'
  get:
    summary: all measurements of the given sample
    description: 'Auth: basic, levels: dev, admin'
    tags:
      - /measurement
    security:
      - BasicAuth: []
    responses:
      200:
        description: measurement details
        content:
          application/json:
            schema:
              type: array
              items:
                allOf:
                  - $ref: 'api.yaml#/components/schemas/Measurement'
                properties:
                  status:
                    type: string
                    description: can be deleted/new/validated
                    example: new
      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/restore/{id}:
  parameters:
    - $ref: 'api.yaml#/components/parameters/Id'
  put:
    summary: restore measurement
    description: 'Auth: basic, levels: dev, admin'
    x-doc: status is set to 0
    tags:
      - /measurement
    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'

/measurement/validate/{id}:
  parameters:
    - $ref: 'api.yaml#/components/parameters/Id'
  put:
    summary: set measurement status to validated
    description: 'Auth: basic, levels: dev, admin'
    x-doc: status is set to 10
    tags:
      - /measurement
    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'

/measurement/new:
  post:
    summary: add measurement
    description: 'Auth: basic, levels: write, 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'