API Reference — Catalog

naftiko: 1.0.0-alpha2
info:
  label: API Reference — Catalog
  description: 'API Reference — Catalog. 2 operations. Lead operation: List all products. Self-contained Naftiko capability
    covering one Zuora business surface.'
  tags:
  - Zuora
  - Catalog
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZUORA_API_KEY: ZUORA_API_KEY
capability:
  consumes:
  - type: http
    namespace: v1-catalog
    baseUri: https://rest.zuora.com
    description: API Reference — Catalog business capability. Self-contained, no shared references.
    resources:
    - name: v1-catalog-products
      path: /v1/catalog/products
      operations:
      - name: getcatalog
        method: GET
        description: List all products
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: zuora-version
          in: header
          type: string
          description: 'The minor version of the Zuora REST API. '
    - name: v1-catalog-products-product-key
      path: /v1/catalog/products/{product-key}
      operations:
      - name: getproduct
        method: GET
        description: Retrieve a product
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: zuora-version
          in: header
          type: string
          description: 'The minor version of the Zuora REST API. '
        - name: product-key
          in: path
          type: string
          description: The unique ID, SKU, or product number of the product that you want to retrieve. For example, 8a808255575bdae4015774e9602e16fe,
            SKU-00000987, or PC-00000006.
          required: true
  exposes:
  - type: rest
    namespace: v1-catalog-rest
    port: 8080
    description: REST adapter for API Reference — Catalog. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/catalog/products
      name: v1-catalog-products
      description: REST surface for v1-catalog-products.
      operations:
      - method: GET
        name: getcatalog
        description: List all products
        call: v1-catalog.getcatalog
        with:
          zuora-version: rest.zuora-version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/catalog/products/{product-key}
      name: v1-catalog-products-product-key
      description: REST surface for v1-catalog-products-product-key.
      operations:
      - method: GET
        name: getproduct
        description: Retrieve a product
        call: v1-catalog.getproduct
        with:
          zuora-version: rest.zuora-version
          product-key: rest.product-key
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v1-catalog-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — Catalog. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-all-products
      description: List all products
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-catalog.getcatalog
      with:
        zuora-version: tools.zuora-version
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-product
      description: Retrieve a product
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-catalog.getproduct
      with:
        zuora-version: tools.zuora-version
        product-key: tools.product-key
      outputParameters:
      - type: object
        mapping: $.