---
openapi: 3.1.0
components:
  schemas:
    ApiError:
      externalDocs:
        description: Error Handling documentation
      type: object
      properties:
        title:
          type: string
          description: A short description about the sort of error
        status:
          type: integer
          format: int32
          description: The HTTP status code
        detail:
          type: string
          description: A longer description about the error
        logref:
          type: string
          description: An UUID that can help retrace the error in the logs
        errorCode:
          type: object
          description: "An application error code, omitted for technical errors"
    StatusInfoResponse:
      type: object
      properties:
        name:
          type: string
          description: The product name
        status:
          description: "The product status, possible values are OK, MAINTENANCE, DEGRADED,\
            \ PARTIAL_OUTAGE or MAJOR_OUTAGE."
          type: string
          examples:
          - OK
tags:
- name: Status
  description: Product status endpoints
paths:
  /api/rest/v1/status/{product}:
    get:
      summary: Get product status
      description: Get the status of a Dioss product
      operationId: StatusResource_getStatus
      tags:
      - Status
      parameters:
      - name: product
        in: path
        required: true
        schema:
          description: The product name.
          type: string
      responses:
        "404":
          description: Application not found
          content:
            application/problem+json:
              examples:
                Not allowed:
                  value:
                    title: Application not found
                    status: "404"
                    logref: 0496cddc-0867-4f8b-aaca-f9536a07d2e9
              schema:
                $ref: "#/components/schemas/ApiError"
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/StatusInfoResponse"
info:
  title: Dioss Product Status REST API
  version: "1.0 ${scm.version}"
  description: API documentation for integrators
