API Reference — subpackage_entities

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_entities
  description: 'API Reference — subpackage_entities. 2 operations. Lead operation: Get Entity. Self-contained Naftiko capability
    covering one Polytomic business surface.'
  tags:
  - Polytomic
  - subpackage_entities
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    POLYTOMIC_API_KEY: POLYTOMIC_API_KEY
capability:
  consumes:
  - type: http
    namespace: polytomic-subpackage-entities
    baseUri: https://app.polytomic.com
    description: API Reference — subpackage_entities business capability. Self-contained, no shared references.
    resources:
    - name: api-entities-id
      path: /api/entities/{id}
      operations:
      - name: get
        method: GET
        description: Get Entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: UUID of the entity to resolve.
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    - name: api-organizations-entities-id
      path: /api/organizations/entities/{id}
      operations:
      - name: getforpartner
        method: GET
        description: Get Partner Entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: UUID of the entity to resolve.
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer partner API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    authentication:
      type: bearer
      token: '{{env.POLYTOMIC_API_KEY}}'
  exposes:
  - type: rest
    namespace: polytomic-subpackage-entities-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_entities. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/entities/{id}
      name: api-entities-id
      description: REST surface for api-entities-id.
      operations:
      - method: GET
        name: get
        description: Get Entity
        call: polytomic-subpackage-entities.get
        with:
          id: rest.id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/organizations/entities/{id}
      name: api-organizations-entities-id
      description: REST surface for api-organizations-entities-id.
      operations:
      - method: GET
        name: getforpartner
        description: Get Partner Entity
        call: polytomic-subpackage-entities.getforpartner
        with:
          id: rest.id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: polytomic-subpackage-entities-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_entities. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-entity
      description: Get Entity
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-entities.get
      with:
        id: tools.id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: get-partner-entity
      description: Get Partner Entity
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-entities.getforpartner
      with:
        id: tools.id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.