definma-api/api/template.yaml

/template/treatments:
  get:
    summary: all available treatment methods
    description: 'Auth: basic, levels: read, write, maintain, dev, admin'
    tags:
      - /template
    security:
      - BasicAuth: []
    responses:
      200:
        description: list of treatments
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: 'api.yaml#/components/schemas/TreatmentTemplate'
      401:
        $ref: 'api.yaml#/components/responses/401'
      500:
        $ref: 'api.yaml#/components/responses/500'

/template/treatment/{id}:
  parameters:
    - $ref: 'api.yaml#/components/parameters/Id'
  get:
    summary: treatment method details
    description: 'Auth: basic, levels: read, write, maintain, admin'
    tags:
      - /template
    security:
      - BasicAuth: []
    responses:
      200:
        description: treatment details
        content:
          application/json:
            schema:
              $ref: 'api.yaml#/components/schemas/TreatmentTemplate'
      401:
        $ref: 'api.yaml#/components/responses/401'
      404:
        $ref: 'api.yaml#/components/responses/404'
      500:
        $ref: 'api.yaml#/components/responses/500'
  put:
    summary: change treatment method
    description: 'Auth: basic, levels: maintain, admin'
    x-doc: With a change a new version is set, resulting in a new template with a new id
    tags:
      - /template
    security:
        - BasicAuth: []
    requestBody:
      required: true
      content:
        application/json:
          schema:
            $ref: 'api.yaml#/components/schemas/TreatmentTemplate'
    responses:
      200:
        description: treatment details
        content:
          application/json:
            schema:
              $ref: 'api.yaml#/components/schemas/TreatmentTemplate'
      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/treatment/new:
  post:
    summary: add treatment method
    description: 'Auth: basic, levels: maintain, admin'
    tags:
      - /template
    security:
      - BasicAuth: []
    requestBody:
      required: true
      content:
        application/json:
          schema:
            $ref: 'api.yaml#/components/schemas/TreatmentTemplate'
    responses:
      200:
        description: treatment details
        content:
          application/json:
            schema:
              $ref: 'api.yaml#/components/schemas/TreatmentTemplate'
      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'

/template/measurements:
  get:
    summary: all available measurement methods
    description: 'Auth: basic, levels: read, write, maintain, dev, admin'
    tags:
      - /template
    security:
      - BasicAuth: []
    responses:
      200:
        description: list of measurement methods
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: 'api.yaml#/components/schemas/Template'
      401:
        $ref: 'api.yaml#/components/responses/401'
      500:
        $ref: 'api.yaml#/components/responses/500'
/template/measurement/{id}:
  parameters:
    - $ref: 'api.yaml#/components/parameters/Id'
  get:
    summary: measurement method details
    description: 'Auth: basic, levels: read, write, maintain, admin'
    tags:
      - /template
    security:
      - BasicAuth: []
    responses:
      200:
        description: measurement details
        content:
          application/json:
            schema:
              $ref: 'api.yaml#/components/schemas/Template'
      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 method
    description: 'Auth: basic, levels: maintain, admin'
    tags:
      - /template
    security:
      - BasicAuth: []
    requestBody:
      required: true
      content:
        application/json:
          schema:
            $ref: 'api.yaml#/components/schemas/Template'
    responses:
      200:
        description: measurement details
        content:
          application/json:
            schema:
              $ref: 'api.yaml#/components/schemas/Template'
      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/measurement/new:
  post:
    summary: add measurement method
    description: 'Auth: basic, levels: maintain, admin'
    tags:
      - /template
    security:
      - BasicAuth: []
    requestBody:
      required: true
      content:
        application/json:
          schema:
            $ref: 'api.yaml#/components/schemas/Template'
    responses:
      200:
        description: measurement details
        content:
          application/json:
            schema:
              $ref: 'api.yaml#/components/schemas/Template'
      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'