API Reference — Settings

naftiko: 1.0.0-alpha2
info:
  label: API Reference — Settings
  description: 'API Reference — Settings. 2 operations. Lead operation: Submit settings requests. Self-contained Naftiko capability
    covering one Zuora business surface.'
  tags:
  - Zuora
  - Settings
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZUORA_API_KEY: ZUORA_API_KEY
capability:
  consumes:
  - type: http
    namespace: v1-settings
    baseUri: https://rest.zuora.com
    description: API Reference — Settings business capability. Self-contained, no shared references.
    resources:
    - name: settings-batch-requests
      path: /settings/batch-requests
      operations:
      - name: postprocesssettingsbatchrequest
        method: POST
        description: Submit settings requests
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: batchRequest
          in: body
          type: string
          required: true
    - name: settings-listing
      path: /settings/listing
      operations:
      - name: getlistallsettings
        method: GET
        description: List all settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Accept
          in: header
          type: string
          description: Specifies response media type. If you omit the `Accept` header parameter, the response body is by default
            in JSON format. If you include `Accept` header paramet
  exposes:
  - type: rest
    namespace: v1-settings-rest
    port: 8080
    description: REST adapter for API Reference — Settings. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/settings/batch-requests
      name: settings-batch-requests
      description: REST surface for settings-batch-requests.
      operations:
      - method: POST
        name: postprocesssettingsbatchrequest
        description: Submit settings requests
        call: v1-settings.postprocesssettingsbatchrequest
        with:
          batchRequest: rest.batchRequest
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/settings/listing
      name: settings-listing
      description: REST surface for settings-listing.
      operations:
      - method: GET
        name: getlistallsettings
        description: List all settings
        call: v1-settings.getlistallsettings
        with:
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v1-settings-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — Settings. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: submit-settings-requests
      description: Submit settings requests
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-settings.postprocesssettingsbatchrequest
      with:
        batchRequest: tools.batchRequest
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-settings
      description: List all settings
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-settings.getlistallsettings
      with:
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.