openapi: 3.0.3
info:
  title: Jaeger Query Dependencies API
  description: The Jaeger Query API provides HTTP endpoints for retrieving trace data, service information, operations, and dependency graphs from the Jaeger distributed tracing backend. This API is exposed by the jaeger-query component and is used by the Jaeger UI and other clients to search and retrieve distributed traces collected across microservices.
  version: 1.0.0
  contact:
    name: Jaeger Project
    url: https://www.jaegertracing.io/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:16686
  description: Default Jaeger Query server
tags:
- name: Dependencies
  description: Endpoints for retrieving service dependency graphs.
paths:
  /api/dependencies:
    get:
      operationId: getDependencies
      summary: Get service dependency graph
      description: Retrieve the dependency graph showing relationships between services based on observed traces. Returns edges representing calls from one service to another with call counts.
      tags:
      - Dependencies
      parameters:
      - name: endTs
        in: query
        description: End timestamp in Unix milliseconds.
        required: true
        schema:
          type: integer
          format: int64
      - name: lookback
        in: query
        description: Duration to look back from endTs in milliseconds.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: A list of service dependency links.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/DependencyLink'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/StructuredError'
        '400':
          description: Invalid query parameters.
        '500':
          description: Internal server error.
components:
  schemas:
    StructuredError:
      type: object
      description: A structured error returned by the API.
      properties:
        code:
          type: integer
          description: Error code.
        msg:
          type: string
          description: Error message.
        traceID:
          type: string
          description: Trace ID associated with the error, if applicable.
    DependencyLink:
      type: object
      description: A dependency link represents an observed call relationship between two services within the traced system.
      properties:
        parent:
          type: string
          description: The calling (upstream) service name.
        child:
          type: string
          description: The called (downstream) service name.
        callCount:
          type: integer
          format: int64
          description: The number of calls observed between the services.
      required:
      - parent
      - child
      - callCount