Couchbase Backup Service REST API — Tasks

naftiko: 1.0.0-alpha2
info:
  label: Couchbase Backup Service REST API — Tasks
  description: 'Couchbase Backup Service REST API — Tasks. 3 operations. Lead operation: Pause repository tasks. Self-contained
    Naftiko capability covering one Couchbase business surface.'
  tags:
  - Couchbase
  - Tasks
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COUCHBASE_API_KEY: COUCHBASE_API_KEY
capability:
  consumes:
  - type: http
    namespace: backup-service-rest-tasks
    baseUri: https://localhost:8097
    description: Couchbase Backup Service REST API — Tasks business capability. Self-contained, no shared references.
    resources:
    - name: api-v1-cluster-self-repository-active-repositoryId-pause
      path: /api/v1/cluster/self/repository/active/{repositoryId}/pause
      operations:
      - name: pauserepositorytasks
        method: POST
        description: Pause repository tasks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-v1-cluster-self-repository-active-repositoryId-resume
      path: /api/v1/cluster/self/repository/active/{repositoryId}/resume
      operations:
      - name: resumerepositorytasks
        method: POST
        description: Resume repository tasks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-v1-cluster-self-repository-active-repositoryId-taskHistory
      path: /api/v1/cluster/self/repository/active/{repositoryId}/taskHistory
      operations:
      - name: getrepositorytaskhistory
        method: GET
        description: Get repository task history
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: offset
          in: query
          type: string
          description: The earliest date for returned tasks
        - name: limit
          in: query
          type: integer
          description: Maximum number of tasks to return
        - name: task_name
          in: query
          type: string
          description: Filter by task name
    authentication:
      type: basic
      username: '{{env.COUCHBASE_USER}}'
      password: '{{env.COUCHBASE_PASS}}'
  exposes:
  - type: rest
    namespace: backup-service-rest-tasks-rest
    port: 8080
    description: REST adapter for Couchbase Backup Service REST API — Tasks. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/api/v1/cluster/self/repository/active/{repositoryid}/pause
      name: api-v1-cluster-self-repository-active-repositoryid-pause
      description: REST surface for api-v1-cluster-self-repository-active-repositoryId-pause.
      operations:
      - method: POST
        name: pauserepositorytasks
        description: Pause repository tasks
        call: backup-service-rest-tasks.pauserepositorytasks
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/cluster/self/repository/active/{repositoryid}/resume
      name: api-v1-cluster-self-repository-active-repositoryid-resume
      description: REST surface for api-v1-cluster-self-repository-active-repositoryId-resume.
      operations:
      - method: POST
        name: resumerepositorytasks
        description: Resume repository tasks
        call: backup-service-rest-tasks.resumerepositorytasks
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/cluster/self/repository/active/{repositoryid}/taskhistory
      name: api-v1-cluster-self-repository-active-repositoryid-taskhistory
      description: REST surface for api-v1-cluster-self-repository-active-repositoryId-taskHistory.
      operations:
      - method: GET
        name: getrepositorytaskhistory
        description: Get repository task history
        call: backup-service-rest-tasks.getrepositorytaskhistory
        with:
          offset: rest.offset
          limit: rest.limit
          task_name: rest.task_name
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: backup-service-rest-tasks-mcp
    port: 9090
    transport: http
    description: MCP adapter for Couchbase Backup Service REST API — Tasks. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: pause-repository-tasks
      description: Pause repository tasks
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: backup-service-rest-tasks.pauserepositorytasks
      outputParameters:
      - type: object
        mapping: $.
    - name: resume-repository-tasks
      description: Resume repository tasks
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: backup-service-rest-tasks.resumerepositorytasks
      outputParameters:
      - type: object
        mapping: $.
    - name: get-repository-task-history
      description: Get repository task history
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: backup-service-rest-tasks.getrepositorytaskhistory
      with:
        offset: tools.offset
        limit: tools.limit
        task_name: tools.task_name
      outputParameters:
      - type: object
        mapping: $.