openapi.yaml

openapi: 3.0.3
info:
  title: Status Dashboard API
  version: 1.0.0
servers:
  - url: http://localhost:8000
tags:
  - name: incidents
    description: Incident management
  - name: components
    description: Operations about components
  - name: v1
    description: Deprecated API schema for backward compatibility
paths:
  /v2/components:
    get:
      summary: Get all components.
      tags:
        - components
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Component'
    post:
      summary: In development.
      tags:
        - components
      responses:
        '200':
          description: API under development.
  /v2/components/{component_id}:
    get:
      summary: Get target component.
      tags:
        - components
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Component'
        '404':
          description: The component is not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errMsg:
                    type: string
                    example: component does not exist

        '500':
          description: internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
    patch:
      summary: Update target component.
      tags:
        - components
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Component'
        '404':
          description: The component is not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errMsg:
                    type: string
                    example: component does not exist

        '500':
          description: internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
  /v2/availability:
    get:
      summary: Get availability.
      tags:
        - availability
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ComponentAvailability'
  /v2/incidents:
    get:
      summary: Get all incidents.
      tags:
        - incidents
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Incidents'
    post:
      summary: Create an incident.
      tags:
        - incidents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IncidentPost'
        required: true
      responses:
        '200':
          description: Create an incident.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncidentPostResponse'
  /v2/incidents/{incident_id}:
    get:
      summary: Find an incident by id.
      description: Returns a single incident.
      tags:
        - incidents
      parameters:
        - name: incident_id
          in: path
          description: ID of incident to return
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Incident'
        '400':
          description: Invalid ID supplied
        '404':
          description: Incident not found.
    patch:
      summary: Update an incident.
      tags:
        - incidents
      parameters:
        - name: incident_id
          in: path
          description: ID of incident to return
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IncidentPost'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Incident'
        '400':
          description: Invalid ID supplied
        '404':
          description: Incident not found.
  /v1/component_status:
    get:
      summary: Get all components.
      tags:
        - v1
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ComponentV1'
    post:
      summary: Update component status.
      tags:
        - v1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComponentPostV1'
      responses:
        '201':
          description: Successful operation.
          content:
            application/json:
              schema:
                  $ref: '#/components/schemas/IncidentV1'

  /v1/incidents:
    get:
      summary: Get all incidents.
      tags:
        - v1
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncidentsV1'

components:
  schemas:
    Component:
      type: object
      required:
        - id
        - name
        - attrs
      properties:
        id:
          type: integer
          format: int64
          example: 218
        name:
          type: string
          example: "Object Storage Service"
        attrs:
          $ref: '#/components/schemas/ComponentAttr'
    ComponentAttr:
      type: object
      properties:
        name:
          type: string
          enum:
            - category
            - region
            - type
          example: "category"
        value:
          type: string
          example: "Storage"
    ComponentNotFound:
      type: object
      properties:
        errMsg:
          type: string
          example: internal server error
    ComponentAvailability:
      type: object
      required:
        - id
        - name
        - region
        - availability
      properties:
        id:
          type: integer
          format: int64
          example: 218
        name:
          type: string
          example: "Auto Scaling"
        region:
          type: string
          example: "EU-DE"
        availability:
          type: array
          items:
            type: object
            required:
              - year
              - month
              - percentage
            properties:
              year:
                type: integer
                example: 2024
              month:
                type: integer
                example: 5
              percentage:
                type: number
                format: float
                example: 99.999666
    Incidents:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Incident'
    Incident:
      type: object
      required:
        - title
        - impact
        - components
        - start_date
        - system
      properties:
        id:
          type: integer
          format: int64
          example: 200
        title:
          type: string
          example: "OpenStack Upgrade in regions EU-DE/EU-NL"
        impact:
          type: integer
          enum: [0,1,2,3]
          example: 1
        components:
          type: array
          items:
            type: string
          example: [218, 254]
        start_date:
          type: string
          format: date-time
        end_date:
          type: string
          format: date-time
        system:
          type: boolean
          example: false
        updates:
          type: array
          items:
            $ref: '#/components/schemas/IncidentStatus'
    IncidentPost:
      type: object
      required:
        - title
        - impact
        - components
        - start_date
      properties:
        title:
          type: string
          example: "OpenStack Upgrade in regions EU-DE/EU-NL"
        description:
          type: string
          example: "Any description for maintenance incident."
        impact:
          type: integer
          enum: [ 0,1,2,3 ]
          example: 1
        components:
          type: array
          items:
            type: string
          example: [ 218, 254 ]
        start_date:
          type: string
          format: date-time
        end_date:
          type: string
          format: date-time
        system:
          type: boolean
          example: false
    IncidentPostResponse:
      type: object
      properties:
        result:
          type: array
          items:
            $ref: "#/components/schemas/IncidentPostResult"
    IncidentPostResult:
      type: object
      properties:
        component_id:
          type: integer
          format: int64
          nullable: false
          example: 254
        incident_id:
          type: integer
          format: int64
          nullable: false
          example: 123
    IncidentStatus:
      type: object
      allOf:
        - type: object
          properties:
            id:
              type: integer
              format: int64
              nullable: true
              example: 163
        - $ref: '#/components/schemas/IncidentStatusPost'
    IncidentStatusPost:
      type: object
      properties:
        status:
          type: string
          example: "resolved"
        text:
          type: string
          example: "issue resolved"
        timestamp:
          type: string
          format: date-time
    IncidentsV1:
      type: array
      items:
        $ref: '#/components/schemas/IncidentV1'
    IncidentV1:
      type: object
      required:
        - text
        - impact
        - start_date
      properties:
        id:
          type: integer
          format: int64
          example: 200
        text:
          type: string
          example: "OpenStack Upgrade in regions EU-DE/EU-NL"
        impact:
          type: integer
          enum: [ 0,1,2,3 ]
          example: 1
        start_date:
          type: string
          example: "2006-01-13 17:02"
        end_date:
          type: string
          example: "2006-01-14 17:10"
        updates:
          type: array
          items:
            $ref: '#/components/schemas/IncidentStatusPostV1'
    IncidentStatusPostV1:
      type: object
      properties:
        status:
          type: string
          example: "resolved"
        text:
          type: string
          example: "issue resolved"
        timestamp:
          type: string
          example: "2006-01-14 17:10"
    ComponentV1:
      type: object
      required:
        - id
        - name
        - attributes
      properties:
        id:
          type: integer
          format: int64
          example: 218
        name:
          type: string
          example: "Object Storage Service"
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/ComponentAttrV1'
        incidents:
          $ref: '#/components/schemas/IncidentsV1'
    ComponentPostV1:
      type: object
      required:
        - name
        - impact
      properties:
        text:
          type: string
          example: Incident
        name:
          type: string
          example: "cmp1"
        impact:
          type: integer
          enum:
            - 0
            - 1
            - 2
            - 3
          example: 1
        attributes:
          $ref: '#/components/schemas/ComponentAttrV1'
    ComponentAttrV1:
      type: object
      properties:
        name:
          type: string
          enum:
            - category
            - region
            - type
          example: "category"
        value:
          type: string
          example: "Storage"
    InternalServerError:
      type: object
      properties:
        errMsg:
          type: string
          example: internal server error