SearchStax Provisioning API — Usage

naftiko: 1.0.0-alpha2
info:
  label: SearchStax Provisioning API — Usage
  description: 'SearchStax Provisioning API — Usage. 1 operations. Lead operation: Get Usage. Self-contained Naftiko capability
    covering one Searchstax business surface.'
  tags:
  - Searchstax
  - Usage
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SEARCHSTAX_API_KEY: SEARCHSTAX_API_KEY
capability:
  consumes:
  - type: http
    namespace: provisioning-usage
    baseUri: https://app.searchstax.com/api/rest/v2
    description: SearchStax Provisioning API — Usage business capability. Self-contained, no shared references.
    resources:
    - name: account-account_name-usage-year-month
      path: /account/{account_name}/usage/{year}/{month}/
      operations:
      - name: getusage
        method: GET
        description: Get Usage
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: year
          in: path
          type: integer
          required: true
        - name: month
          in: path
          type: integer
          required: true
    authentication:
      type: bearer
      token: '{{env.SEARCHSTAX_API_KEY}}'
  exposes:
  - type: rest
    namespace: provisioning-usage-rest
    port: 8080
    description: REST adapter for SearchStax Provisioning API — Usage. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/account/{account-name}/usage/{year}/{month}
      name: account-account-name-usage-year-month
      description: REST surface for account-account_name-usage-year-month.
      operations:
      - method: GET
        name: getusage
        description: Get Usage
        call: provisioning-usage.getusage
        with:
          year: rest.year
          month: rest.month
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: provisioning-usage-mcp
    port: 9090
    transport: http
    description: MCP adapter for SearchStax Provisioning API — Usage. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-usage
      description: Get Usage
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: provisioning-usage.getusage
      with:
        year: tools.year
        month: tools.month
      outputParameters:
      - type: object
        mapping: $.