API Reference — subpackage_entitlements

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_entitlements
  description: 'API Reference — subpackage_entitlements. 1 operations. Lead operation: List entitlements. Self-contained Naftiko
    capability covering one Flatfile business surface.'
  tags:
  - Flatfile
  - subpackage_entitlements
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FLATFILE_API_KEY: FLATFILE_API_KEY
capability:
  consumes:
  - type: http
    namespace: flatfile-subpackage-entitlements
    baseUri: https://api.x.flatfile.com/v1
    description: API Reference — subpackage_entitlements business capability. Self-contained, no shared references.
    resources:
    - name: entitlements
      path: /entitlements
      operations:
      - name: list
        method: GET
        description: List entitlements
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: resourceId
          in: query
          type: string
          description: The associated Resource ID for the entitlements.
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.FLATFILE_API_KEY}}'
  exposes:
  - type: rest
    namespace: flatfile-subpackage-entitlements-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_entitlements. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/entitlements
      name: entitlements
      description: REST surface for entitlements.
      operations:
      - method: GET
        name: list
        description: List entitlements
        call: flatfile-subpackage-entitlements.list
        with:
          resourceId: rest.resourceId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: flatfile-subpackage-entitlements-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_entitlements. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-entitlements
      description: List entitlements
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flatfile-subpackage-entitlements.list
      with:
        resourceId: tools.resourceId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.