Hatchet Observability API

openapi: 3.1.0
info:
  version: 1.0.0
  title: Hatchet API Token Observability API
  description: The Hatchet API
servers:
- url: ''
security:
- bearerAuth: []
- cookieAuth: []
tags:
- name: Observability
paths:
  /api/v1/stable/tenants/{tenant}/traces:
    get:
      x-resources:
      - tenant
      description: Get OTel trace for a workflow run
      operationId: v1-observability:get-trace
      parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The workflow run external id
        in: query
        name: run_external_id
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The number of spans to skip
        in: query
        name: offset
        required: false
        schema:
          type: integer
          format: int64
      - description: The number of spans to limit by
        in: query
        name: limit
        required: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OtelSpanList'
          description: Successfully retrieved the OTel trace
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIErrors'
          description: A malformed or bad request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIErrors'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIErrors'
          description: Trace not found
      summary: Get Otel Trace
      tags:
      - Observability
components:
  schemas:
    PaginationResponse:
      type: object
      properties:
        current_page:
          type: integer
          description: the current page
          format: int64
          example: 2
        next_page:
          type: integer
          description: the next page
          format: int64
          example: 3
        num_pages:
          type: integer
          description: the total number of pages for listing
          format: int64
          example: 10
      example:
        next_page: 3
        num_pages: 10
        current_page: 2
    OtelSpanList:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/PaginationResponse'
        retryCounts:
          type: array
          items:
            type: integer
            format: int32
        rows:
          type: array
          items:
            $ref: '#/components/schemas/OtelSpan'
    OtelSpan:
      type: object
      properties:
        traceId:
          type: string
        spanId:
          type: string
        parentSpanId:
          type: string
        spanName:
          type: string
        spanKind:
          $ref: '#/components/schemas/OtelSpanKind'
        serviceName:
          type: string
        statusCode:
          $ref: '#/components/schemas/OtelStatusCode'
        statusMessage:
          type: string
        durationNs:
          type: integer
          format: int64
        createdAt:
          type: string
          format: date-time
        resourceAttributes:
          type: object
          additionalProperties:
            type: string
        spanAttributes:
          type: object
          additionalProperties:
            type: string
        scopeName:
          type: string
        scopeVersion:
          type: string
        retryCount:
          type: integer
          format: int32
      required:
      - traceId
      - spanId
      - spanName
      - spanKind
      - serviceName
      - statusCode
      - durationNs
      - createdAt
      - retryCount
    OtelStatusCode:
      type: string
      enum:
      - UNSET
      - OK
      - ERROR
    OtelSpanKind:
      type: string
      enum:
      - UNSPECIFIED
      - INTERNAL
      - SERVER
      - CLIENT
      - PRODUCER
      - CONSUMER
    APIErrors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/APIError'
      required:
      - errors
    APIError:
      type: object
      properties:
        code:
          type: integer
          description: a custom Hatchet error code
          format: uint64
          example: 1400
        field:
          type: string
          description: the field that this error is associated with, if applicable
          example: name
        description:
          type: string
          description: a description for this error
          example: A descriptive error message
        docs_link:
          type: string
          description: a link to the documentation for this error, if it exists
          example: github.com/hatchet-dev/hatchet
      required:
      - description
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    cookieAuth:
      type: apiKey
      in: cookie
      name: hatchet
    customAuth:
      type: http
      scheme: bearer