Red Hat 3scale Service Management API — Reporting

naftiko: 1.0.0-alpha2
info:
  label: Red Hat 3scale Service Management API — Reporting
  description: 'Red Hat 3scale Service Management API — Reporting. 2 operations. Lead operation: Report API Transactions.
    Self-contained Naftiko capability covering one Red Hat 3scale business surface.'
  tags:
  - Red Hat 3scale
  - Reporting
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    RED_HAT_3SCALE_API_KEY: RED_HAT_3SCALE_API_KEY
capability:
  consumes:
  - type: http
    namespace: service-management-reporting
    baseUri: https://su1.3scale.net
    description: Red Hat 3scale Service Management API — Reporting business capability. Self-contained, no shared references.
    resources:
    - name: transactions.xml
      path: /transactions.xml
      operations:
      - name: reporttransactions
        method: POST
        description: Report API Transactions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: transactions-authrep.xml
      path: /transactions/authrep.xml
      operations:
      - name: authorizeandreport
        method: GET
        description: Authorize and Report API Transaction
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: provider_key
          in: query
          type: string
          description: The provider key identifying your 3scale account
          required: true
        - name: user_key
          in: query
          type: string
          description: The API key of the application making the call
          required: true
        - name: service_id
          in: query
          type: string
          description: The ID of the service being accessed
        - name: usage[hits]
          in: query
          type: integer
          description: Number of hits to report
    authentication:
      type: apikey
      key: provider_key
      value: '{{env.RED_HAT_3SCALE_API_KEY}}'
      placement: query
  exposes:
  - type: rest
    namespace: service-management-reporting-rest
    port: 8080
    description: REST adapter for Red Hat 3scale Service Management API — Reporting. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/transactions-xml
      name: transactions-xml
      description: REST surface for transactions.xml.
      operations:
      - method: POST
        name: reporttransactions
        description: Report API Transactions
        call: service-management-reporting.reporttransactions
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/transactions/authrep-xml
      name: transactions-authrep-xml
      description: REST surface for transactions-authrep.xml.
      operations:
      - method: GET
        name: authorizeandreport
        description: Authorize and Report API Transaction
        call: service-management-reporting.authorizeandreport
        with:
          provider_key: rest.provider_key
          user_key: rest.user_key
          service_id: rest.service_id
          usage[hits]: rest.usage[hits]
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: service-management-reporting-mcp
    port: 9090
    transport: http
    description: MCP adapter for Red Hat 3scale Service Management API — Reporting. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: report-api-transactions
      description: Report API Transactions
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: service-management-reporting.reporttransactions
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: authorize-and-report-api-transaction
      description: Authorize and Report API Transaction
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: service-management-reporting.authorizeandreport
      with:
        provider_key: tools.provider_key
        user_key: tools.user_key
        service_id: tools.service_id
        usage[hits]: tools.usage[hits]
      outputParameters:
      - type: object
        mapping: $.