API Reference — subpackage_annotationHistory

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_annotationHistory
  description: 'API Reference — subpackage_annotationHistory. 4 operations. Lead operation: ✨ List all annotation history
    items for annotation. Self-contained Naftiko capability covering one Label Studio business surface.'
  tags:
  - Label Studio
  - subpackage_annotationHistory
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    LABEL_STUDIO_API_KEY: LABEL_STUDIO_API_KEY
capability:
  consumes:
  - type: http
    namespace: label-studio-subpackage-annotationhistory
    baseUri: http://localhost:8000
    description: API Reference — subpackage_annotationHistory business capability. Self-contained, no shared references.
    resources:
    - name: api-annotation-history
      path: /api/annotation-history/
      operations:
      - name: list
        method: GET
        description: ✨ List all annotation history items for annotation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: annotation
          in: query
          type: integer
          description: Annotation ID to get annotation history items for.
        - name: ordering
          in: query
          type: string
          description: Which field to use when ordering the results.
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
      - name: delete
        method: DELETE
        description: ✨ Delete annotation history items
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: annotation
          in: query
          type: integer
          description: Annotation ID to delete annotation history items for.
        - name: project
          in: query
          type: integer
          description: Project ID to delete annotation history items for.
        - name: task
          in: query
          type: integer
          description: Task ID to delete annotation history items for.
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
    - name: api-annotation-history-id
      path: /api/annotation-history/{id}/
      operations:
      - name: retrieve
        method: GET
        description: ✨ Retrieve a single annotation history item (full result for hydration)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
    - name: api-projects-id-annotation-history
      path: /api/projects/{id}/annotation-history/
      operations:
      - name: listforproject
        method: GET
        description: ✨ List annotation history items for project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
        - name: page
          in: query
          type: integer
          description: A page number within the paginated result set.
        - name: page_size
          in: query
          type: integer
          description: Number of results to return per page.
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.LABEL_STUDIO_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: label-studio-subpackage-annotationhistory-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_annotationHistory. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/api/annotation-history
      name: api-annotation-history
      description: REST surface for api-annotation-history.
      operations:
      - method: GET
        name: list
        description: ✨ List all annotation history items for annotation
        call: label-studio-subpackage-annotationhistory.list
        with:
          annotation: rest.annotation
          ordering: rest.ordering
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: ✨ Delete annotation history items
        call: label-studio-subpackage-annotationhistory.delete
        with:
          annotation: rest.annotation
          project: rest.project
          task: rest.task
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/annotation-history/{id}
      name: api-annotation-history-id
      description: REST surface for api-annotation-history-id.
      operations:
      - method: GET
        name: retrieve
        description: ✨ Retrieve a single annotation history item (full result for hydration)
        call: label-studio-subpackage-annotationhistory.retrieve
        with:
          id: rest.id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/projects/{id}/annotation-history
      name: api-projects-id-annotation-history
      description: REST surface for api-projects-id-annotation-history.
      operations:
      - method: GET
        name: listforproject
        description: ✨ List annotation history items for project
        call: label-studio-subpackage-annotationhistory.listforproject
        with:
          id: rest.id
          page: rest.page
          page_size: rest.page_size
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: label-studio-subpackage-annotationhistory-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_annotationHistory. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-all-annotation-history-items
      description: ✨ List all annotation history items for annotation
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio-subpackage-annotationhistory.list
      with:
        annotation: tools.annotation
        ordering: tools.ordering
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-annotation-history-items
      description: ✨ Delete annotation history items
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: label-studio-subpackage-annotationhistory.delete
      with:
        annotation: tools.annotation
        project: tools.project
        task: tools.task
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-single-annotation-history-item
      description: ✨ Retrieve a single annotation history item (full result for hydration)
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio-subpackage-annotationhistory.retrieve
      with:
        id: tools.id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: list-annotation-history-items-project
      description: ✨ List annotation history items for project
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio-subpackage-annotationhistory.listforproject
      with:
        id: tools.id
        page: tools.page
        page_size: tools.page_size
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.