Apache BookKeeper Admin API — Bookies

naftiko: 1.0.0-alpha2
info:
  label: Apache BookKeeper Admin API — Bookies
  description: 'Apache BookKeeper Admin API — Bookies. 7 operations. Lead operation: Apache BookKeeper Get Cluster Info. Self-contained
    Naftiko capability covering one Apache Bookkeeper business surface.'
  tags:
  - Apache Bookkeeper
  - Bookies
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    APACHE_BOOKKEEPER_API_KEY: APACHE_BOOKKEEPER_API_KEY
capability:
  consumes:
  - type: http
    namespace: admin-bookies
    baseUri: http://localhost:8080
    description: Apache BookKeeper Admin API — Bookies business capability. Self-contained, no shared references.
    resources:
    - name: api-v1-bookie-cluster_info
      path: /api/v1/bookie/cluster_info
      operations:
      - name: getclusterinfo
        method: GET
        description: Apache BookKeeper Get Cluster Info
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-v1-bookie-gc
      path: /api/v1/bookie/gc
      operations:
      - name: getgcstatus
        method: GET
        description: Apache BookKeeper Get Garbage Collection Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: triggergarbagecollection
        method: PUT
        description: Apache BookKeeper Trigger Garbage Collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-v1-bookie-info
      path: /api/v1/bookie/info
      operations:
      - name: getbookieinfo
        method: GET
        description: Apache BookKeeper Get Bookie Info
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-v1-bookie-is_ready
      path: /api/v1/bookie/is_ready
      operations:
      - name: isbookieready
        method: GET
        description: Apache BookKeeper Check Bookie Readiness
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-v1-bookie-list_bookies
      path: /api/v1/bookie/list_bookies
      operations:
      - name: listbookies
        method: GET
        description: Apache BookKeeper List Bookies
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: query
          type: string
          description: Bookie type filter — "rw" for read-write or "ro" for read-only.
          required: true
        - name: print_hostnames
          in: query
          type: boolean
          description: If true, include hostname in the response.
    - name: api-v1-bookie-state
      path: /api/v1/bookie/state
      operations:
      - name: getbookiestate
        method: GET
        description: Apache BookKeeper Get Bookie State
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: admin-bookies-rest
    port: 8080
    description: REST adapter for Apache BookKeeper Admin API — Bookies. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v1/bookie/cluster-info
      name: api-v1-bookie-cluster-info
      description: REST surface for api-v1-bookie-cluster_info.
      operations:
      - method: GET
        name: getclusterinfo
        description: Apache BookKeeper Get Cluster Info
        call: admin-bookies.getclusterinfo
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/bookie/gc
      name: api-v1-bookie-gc
      description: REST surface for api-v1-bookie-gc.
      operations:
      - method: GET
        name: getgcstatus
        description: Apache BookKeeper Get Garbage Collection Status
        call: admin-bookies.getgcstatus
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: triggergarbagecollection
        description: Apache BookKeeper Trigger Garbage Collection
        call: admin-bookies.triggergarbagecollection
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/bookie/info
      name: api-v1-bookie-info
      description: REST surface for api-v1-bookie-info.
      operations:
      - method: GET
        name: getbookieinfo
        description: Apache BookKeeper Get Bookie Info
        call: admin-bookies.getbookieinfo
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/bookie/is-ready
      name: api-v1-bookie-is-ready
      description: REST surface for api-v1-bookie-is_ready.
      operations:
      - method: GET
        name: isbookieready
        description: Apache BookKeeper Check Bookie Readiness
        call: admin-bookies.isbookieready
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/bookie/list-bookies
      name: api-v1-bookie-list-bookies
      description: REST surface for api-v1-bookie-list_bookies.
      operations:
      - method: GET
        name: listbookies
        description: Apache BookKeeper List Bookies
        call: admin-bookies.listbookies
        with:
          type: rest.type
          print_hostnames: rest.print_hostnames
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/bookie/state
      name: api-v1-bookie-state
      description: REST surface for api-v1-bookie-state.
      operations:
      - method: GET
        name: getbookiestate
        description: Apache BookKeeper Get Bookie State
        call: admin-bookies.getbookiestate
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: admin-bookies-mcp
    port: 9090
    transport: http
    description: MCP adapter for Apache BookKeeper Admin API — Bookies. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: apache-bookkeeper-get-cluster-info
      description: Apache BookKeeper Get Cluster Info
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-bookies.getclusterinfo
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-bookkeeper-get-garbage-collection
      description: Apache BookKeeper Get Garbage Collection Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-bookies.getgcstatus
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-bookkeeper-trigger-garbage-collection
      description: Apache BookKeeper Trigger Garbage Collection
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: admin-bookies.triggergarbagecollection
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-bookkeeper-get-bookie-info
      description: Apache BookKeeper Get Bookie Info
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-bookies.getbookieinfo
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-bookkeeper-check-bookie-readiness
      description: Apache BookKeeper Check Bookie Readiness
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-bookies.isbookieready
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-bookkeeper-list-bookies
      description: Apache BookKeeper List Bookies
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-bookies.listbookies
      with:
        type: tools.type
        print_hostnames: tools.print_hostnames
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-bookkeeper-get-bookie-state
      description: Apache BookKeeper Get Bookie State
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-bookies.getbookiestate
      outputParameters:
      - type: object
        mapping: $.