openapi: 3.2.0
info:
  title: Testkube Debug API
  description: Testkube provides a Kubernetes-native framework for test definition, execution and results
  contact:
    email: contact@testkube.io
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 1.0.0
tags:
- name: Debug
paths:
  /debug:
    get:
      tags:
      - Debug
      summary: Get debug information
      description: Gets information that is needed for debugging and opening Testkube bug reports
      operationId: getDebugInfo
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DebugInfo'
        500:
          description: problem with getting execution logs from storage
          content:
            application/problem+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Problem'
        502:
          description: problem with getting debug information from the Kuberenetes cluster
          content:
            application/problem+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Problem'
components:
  schemas:
    DebugInfo:
      description: Testkube debug info
      type: object
      properties:
        clientVersion:
          type: string
          example: 1.4.9
        serverVersion:
          type: string
          example: v1.4.9
        clusterVersion:
          type: string
          example: v1.23.4
        apiLogs:
          type: array
          items:
            type: string
          example:
          - logline1
          - logline2
          - logline3
        operatorLogs:
          type: array
          items:
            type: string
          example:
          - logline1
          - logline2
          - logline3
    Problem:
      description: problem response in case of error
      type: object
      properties:
        type:
          type: string
          description: Type contains a URI that identifies the problem type.
          example: https://kubeshop.io/testkube/problems/invalidtestname
        title:
          type: string
          description: Title is a short, human-readable summary of the problem type. This title SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
          example: Invalid test name
        status:
          type: integer
          description: HTTP status code for this occurrence of the problem.
          example: 500
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
          example: Your test name can't contain forbidden characters like "}}}" passed
        instance:
          type: string
          description: A URI that identifies the specific occurrence of the problem. This URI may or may not yield further information if de-referenced.
          example: http://10.23.23.123:8088/tests
externalDocs:
  description: Find out more about Testkube
  url: https://testkube.kubeshop.io/