openapi: 3.0.3
info:
  version: 1.0.2
  title: LE-KO System API
  license:
    name: private
    url: https:/le-ko.deggex.com
  contact:
    email: denis@deggex.awsapps.com
  description: LE-KO System API
servers:
  - url: https://le-ko-dev.deggex.com/inner
security:
  - api_key: []
tags:
  - name: System
    description: System APIs.
paths:
  /version:
    get:
      summary: /version
      operationId: sysVersion
      description: ✨ Information about latest commit version and build date.
      tags:
        - System
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Version'
        '400':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /integrations:
    get:
      summary: /integrations
      operationId: sysIntegrations
      description: ✨ Returns status of health of all integrations, e.g. DB, Redis, Kafka, etc.
      tags:
        - System
      responses:
        '200':
          description: Status of health of all integrations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Integrations'
        '400':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  securitySchemes:
    api_key:
      type: apiKey
      description: API key to authorize requests.
      name: api_key
      in: query
  schemas:
    Version:
      type: object
      description: Version of latest deployment.
      required:
        - built
        - openapiVersion
        - version
      properties:
        built:
          type: string
          description: Date of build
          example: Wed Nov  6 21:03:00 MSK 2024
        openapiVersion:
          type: string
          description: Open API version
          example: 1.2.3
        version:
          type: string
          description: Environment and commit hash
          example: dev-f6f3db4d
    Error:
      type: object
      required:
        - code
        - message
        - endpoint
        - requestId
      properties:
        code:
          type: string
          description: Error unique code
          enum:
            - validation
            - internal
            - oops
            - unexpected
            - tooManyRequests
            - notFound
            - unauthorized
            - forbidden
        message:
          type: string
          description: Error message
        endpoint:
          type: string
        requestId:
          type: string
    Errors:
      type: object
      required:
        - errors
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
    Integration:
      type: object
      required:
        - probe
        - integration
        - status
        - checkedAt
      properties:
        probe:
          type: string
          description: Probe description
          example: dial network=tcp address=database.deggex.com:5432
        integration:
          type: string
          description: Integration name
          example: DB
        status:
          type: string
          description: Status
          example: error
        checkedAt:
          type: string
          description: Date of check
          example: '2024-11-11T09:21:24.378835433Z'
        error:
          type: string
          description: Error message
          example: 'dial tcp: i/o timeout'
    Integrations:
      type: object
      description: Status of health of all integrations, e.g. DB, Redis, Kafka, etc.
      required:
        - legend
        - summary
        - items
      properties:
        legend:
          type: array
          items:
            type: string
          example:
            - ok
            - warning
            - error
        summary:
          type: array
          description: Summary of statuses
          items:
            type: string
          example:
            - 'Health: kafka.payment status: warning'
            - 'Health: write_db status: ok'
        items:
          type: array
          description: Verbose metrics of status for integration
          items:
            $ref: '#/components/schemas/Integration'