openapi: 3.2.0
info:
  contact:
    email: support@cloudquery.io
    name: CloudQuery Support Team
    url: https://cloudquery.io
  description: Welcome to the CloudQuery Platform API documentation!
  license:
    name: MIT
    url: https://spdx.org/licenses/MIT
  termsOfService: https://www.cloudquery.io/terms
  title: CloudQuery Platform OpenAPI Spec Healthcheck API
  version: 1.0.0
security:
- bearerAuth: []
- cookieAuth: []
tags:
- name: Health Check
paths:
  /:
    get:
      description: Index endpoint, returns 200
      operationId: PlatformIndex
      responses:
        '200':
          description: Response
          headers:
            Link:
              description: RFC 8631 compliant link relation information
              schema:
                type: string
                example: <https://platform-api-docs.cloudquery.io>; rel="service-doc"
        '400':
          content:
            application/json:
              schema:
                allOf:
                - additionalProperties: false
                  description: Basic Error
                  required:
                  - message
                  - status
                  properties:
                    message:
                      type: string
                    status:
                      type: integer
                  title: Basic Error
                  type: object
                - properties:
                    errors:
                      items:
                        type: string
                      type: array
                    field_errors:
                      additionalProperties:
                        type: string
                      type: object
                  type: object
          description: Bad request
      security: []
      tags:
      - Health Check
      summary: Platform index
      x-summary-source: derived
  /healthcheck:
    get:
      description: Health check endpoint, returns 200
      operationId: PlatformHealthCheck
      responses:
        '200':
          description: Response
        '400':
          $ref: '#/components/responses/PlatformBadRequest'
        '500':
          $ref: '#/components/responses/PlatformInternalError'
        '503':
          $ref: '#/components/responses/PlatformServiceUnavailable'
      security: []
      tags:
      - Health Check
      summary: Platform health check
      x-summary-source: derived
components:
  schemas:
    PlatformFieldError:
      allOf:
      - $ref: '#/components/schemas/PlatformBasicError'
      - properties:
          errors:
            items:
              type: string
            type: array
          field_errors:
            additionalProperties:
              type: string
            type: object
        type: object
    PlatformBasicError:
      additionalProperties: false
      description: Basic Error
      required:
      - message
      - status
      properties:
        message:
          type: string
        status:
          type: integer
      title: Basic Error
      type: object
  responses:
    PlatformInternalError:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformBasicError'
      description: Internal Error
    PlatformServiceUnavailable:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformBasicError'
      description: Service unavailable
    PlatformBadRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformFieldError'
      description: Bad request
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http
    basicAuth:
      scheme: basic
      type: http
    cookieAuth:
      scheme: cookie
      type: http