API Reference — API Health

naftiko: 1.0.0-alpha2
info:
  label: API Reference — API Health
  description: 'API Reference — API Health. 1 operations. Lead operation: List API volume summary records. Self-contained
    Naftiko capability covering one Zuora business surface.'
  tags:
  - Zuora
  - API Health
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZUORA_API_KEY: ZUORA_API_KEY
capability:
  consumes:
  - type: http
    namespace: v1-api-health
    baseUri: https://rest.zuora.com
    description: API Reference — API Health business capability. Self-contained, no shared references.
    resources:
    - name: system-health-api-requests-volume-summary
      path: /system-health/api-requests/volume-summary
      operations:
      - name: getsystemhealthapivolumesummary
        method: GET
        description: List API volume summary records
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: path
          in: query
          type: string
          description: Filters the volume summary by API path name.
        - name: httpMethod
          in: query
          type: string
          description: 'Filters the volume summary by http method. Example: `POST`.'
        - name: startTime
          in: query
          type: string
          description: Start time of the volume summary.
          required: true
        - name: endTime
          in: query
          type: string
          description: End time of the volume summary.
          required: true
  exposes:
  - type: rest
    namespace: v1-api-health-rest
    port: 8080
    description: REST adapter for API Reference — API Health. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/system-health/api-requests/volume-summary
      name: system-health-api-requests-volume-summary
      description: REST surface for system-health-api-requests-volume-summary.
      operations:
      - method: GET
        name: getsystemhealthapivolumesummary
        description: List API volume summary records
        call: v1-api-health.getsystemhealthapivolumesummary
        with:
          path: rest.path
          httpMethod: rest.httpMethod
          startTime: rest.startTime
          endTime: rest.endTime
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v1-api-health-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — API Health. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-api-volume-summary-records
      description: List API volume summary records
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-api-health.getsystemhealthapivolumesummary
      with:
        path: tools.path
        httpMethod: tools.httpMethod
        startTime: tools.startTime
        endTime: tools.endTime
      outputParameters:
      - type: object
        mapping: $.