api.yml

openapi: 3.0.0
servers:
  - description: StorageLeaf API
    url: https://localhost/
info:
  description: The StorageLeaf API
  version: "2.7.0"
  title: StorageLeaf API

paths:
  /version:
    get:
      tags:
        - general
      summary: Gets information about the server version
      operationId: version
      responses:
        '200':
          description: The server version information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Version'
  /devices:
    get:
      tags:
        - device
      summary: Gets all devices
      operationId: devices
      responses:
        '200':
          description: All available devices
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Device'
  /device/{deviceID}:
    get:
      tags:
        - device
      summary: Gets a specific device
      operationId: device
      parameters:
        - in: path
          name: deviceID
          description: The device id
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: The device
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Device'
    delete:
      tags:
        - device
      summary: Deletes a specific device. All correspondig sensors and measurements will be deleted too.
      operationId: deleteDevice
      security:
        - bearerAuth: []
      parameters:
        - in: path
          name: deviceID
          description: The device id
          required: true