Apache BookKeeper Admin API — Ledgers

naftiko: 1.0.0-alpha2
info:
  label: Apache BookKeeper Admin API — Ledgers
  description: 'Apache BookKeeper Admin API — Ledgers. 4 operations. Lead operation: Apache BookKeeper Delete Ledger. Self-contained
    Naftiko capability covering one Apache Bookkeeper business surface.'
  tags:
  - Apache Bookkeeper
  - Ledgers
  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-ledgers
    baseUri: http://localhost:8080
    description: Apache BookKeeper Admin API — Ledgers business capability. Self-contained, no shared references.
    resources:
    - name: api-v1-ledger-delete
      path: /api/v1/ledger/delete
      operations:
      - name: deleteledger
        method: DELETE
        description: Apache BookKeeper Delete Ledger
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ledger_id
          in: query
          type: integer
          description: The ledger ID to delete.
          required: true
    - name: api-v1-ledger-list
      path: /api/v1/ledger/list
      operations:
      - name: listledgers
        method: GET
        description: Apache BookKeeper List Ledgers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: print_metadata
          in: query
          type: boolean
          description: If true, include ledger metadata in the response.
    - name: api-v1-ledger-metadata
      path: /api/v1/ledger/metadata
      operations:
      - name: getledgermetadata
        method: GET
        description: Apache BookKeeper Get Ledger Metadata
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ledger_id
          in: query
          type: integer
          description: The ledger ID (Long) to retrieve metadata for.
          required: true
    - name: api-v1-ledger-read
      path: /api/v1/ledger/read
      operations:
      - name: readledgerentries
        method: GET
        description: Apache BookKeeper Read Ledger Entries
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ledger_id
          in: query
          type: integer
          description: The ledger ID to read entries from.
          required: true
        - name: start_entry_id
          in: query
          type: integer
          description: First entry ID to read (inclusive). Defaults to 0.
        - name: end_entry_id
          in: query
          type: integer
          description: Last entry ID to read (inclusive). Defaults to last entry.
  exposes:
  - type: rest
    namespace: admin-ledgers-rest
    port: 8080
    description: REST adapter for Apache BookKeeper Admin API — Ledgers. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v1/ledger/delete
      name: api-v1-ledger-delete
      description: REST surface for api-v1-ledger-delete.
      operations:
      - method: DELETE
        name: deleteledger
        description: Apache BookKeeper Delete Ledger
        call: admin-ledgers.deleteledger
        with:
          ledger_id: rest.ledger_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/ledger/list
      name: api-v1-ledger-list
      description: REST surface for api-v1-ledger-list.
      operations:
      - method: GET
        name: listledgers
        description: Apache BookKeeper List Ledgers
        call: admin-ledgers.listledgers
        with:
          print_metadata: rest.print_metadata
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/ledger/metadata
      name: api-v1-ledger-metadata
      description: REST surface for api-v1-ledger-metadata.
      operations:
      - method: GET
        name: getledgermetadata
        description: Apache BookKeeper Get Ledger Metadata
        call: admin-ledgers.getledgermetadata
        with:
          ledger_id: rest.ledger_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/ledger/read
      name: api-v1-ledger-read
      description: REST surface for api-v1-ledger-read.
      operations:
      - method: GET
        name: readledgerentries
        description: Apache BookKeeper Read Ledger Entries
        call: admin-ledgers.readledgerentries
        with:
          ledger_id: rest.ledger_id
          start_entry_id: rest.start_entry_id
          end_entry_id: rest.end_entry_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: admin-ledgers-mcp
    port: 9090
    transport: http
    description: MCP adapter for Apache BookKeeper Admin API — Ledgers. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: apache-bookkeeper-delete-ledger
      description: Apache BookKeeper Delete Ledger
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: admin-ledgers.deleteledger
      with:
        ledger_id: tools.ledger_id
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-bookkeeper-list-ledgers
      description: Apache BookKeeper List Ledgers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-ledgers.listledgers
      with:
        print_metadata: tools.print_metadata
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-bookkeeper-get-ledger-metadata
      description: Apache BookKeeper Get Ledger Metadata
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-ledgers.getledgermetadata
      with:
        ledger_id: tools.ledger_id
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-bookkeeper-read-ledger-entries
      description: Apache BookKeeper Read Ledger Entries
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-ledgers.readledgerentries
      with:
        ledger_id: tools.ledger_id
        start_entry_id: tools.start_entry_id
        end_entry_id: tools.end_entry_id
      outputParameters:
      - type: object
        mapping: $.