Uptrace API — Annotations

naftiko: 1.0.0-alpha2
info:
  label: Uptrace API — Annotations
  description: 'Uptrace API — Annotations. 5 operations. Lead operation: List Annotations. Self-contained Naftiko capability
    covering one Uptrace business surface.'
  tags:
  - Uptrace
  - Annotations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UPTRACE_API_KEY: UPTRACE_API_KEY
capability:
  consumes:
  - type: http
    namespace: uptrace-annotations
    baseUri: https://api.uptrace.dev
    description: Uptrace API — Annotations business capability. Self-contained, no shared references.
    resources:
    - name: api-v1-annotations
      path: /api/v1/annotations
      operations:
      - name: listannotations
        method: GET
        description: List Annotations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: query
          type: integer
          description: Project identifier
          required: true
        - name: startTime
          in: query
          type: string
          description: Start of time range (ISO 8601)
        - name: endTime
          in: query
          type: string
          description: End of time range (ISO 8601)
        - name: tags
          in: query
          type: array
          description: Filter by annotation tags
      - name: createannotation
        method: POST
        description: Create Annotation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-v1-annotations-annotationId
      path: /api/v1/annotations/{annotationId}
      operations:
      - name: getannotation
        method: GET
        description: Get Annotation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: annotationId
          in: path
          type: integer
          description: Annotation identifier
          required: true
      - name: updateannotation
        method: PUT
        description: Update Annotation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: annotationId
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteannotation
        method: DELETE
        description: Delete Annotation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: annotationId
          in: path
          type: integer
          required: true
    authentication:
      type: bearer
      token: '{{env.UPTRACE_API_KEY}}'
  exposes:
  - type: rest
    namespace: uptrace-annotations-rest
    port: 8080
    description: REST adapter for Uptrace API — Annotations. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/v1/annotations
      name: api-v1-annotations
      description: REST surface for api-v1-annotations.
      operations:
      - method: GET
        name: listannotations
        description: List Annotations
        call: uptrace-annotations.listannotations
        with:
          projectId: rest.projectId
          startTime: rest.startTime
          endTime: rest.endTime
          tags: rest.tags
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createannotation
        description: Create Annotation
        call: uptrace-annotations.createannotation
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/annotations/{annotationid}
      name: api-v1-annotations-annotationid
      description: REST surface for api-v1-annotations-annotationId.
      operations:
      - method: GET
        name: getannotation
        description: Get Annotation
        call: uptrace-annotations.getannotation
        with:
          annotationId: rest.annotationId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateannotation
        description: Update Annotation
        call: uptrace-annotations.updateannotation
        with:
          annotationId: rest.annotationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteannotation
        description: Delete Annotation
        call: uptrace-annotations.deleteannotation
        with:
          annotationId: rest.annotationId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: uptrace-annotations-mcp
    port: 9090
    transport: http
    description: MCP adapter for Uptrace API — Annotations. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-annotations
      description: List Annotations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: uptrace-annotations.listannotations
      with:
        projectId: tools.projectId
        startTime: tools.startTime
        endTime: tools.endTime
        tags: tools.tags
      outputParameters:
      - type: object
        mapping: $.
    - name: create-annotation
      description: Create Annotation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: uptrace-annotations.createannotation
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-annotation
      description: Get Annotation
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: uptrace-annotations.getannotation
      with:
        annotationId: tools.annotationId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-annotation
      description: Update Annotation
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: uptrace-annotations.updateannotation
      with:
        annotationId: tools.annotationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-annotation
      description: Delete Annotation
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: uptrace-annotations.deleteannotation
      with:
        annotationId: tools.annotationId
      outputParameters:
      - type: object
        mapping: $.