API Reference — subpackage_bulkSync.subpackage_bulkSync/schemas

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_bulkSync.subpackage_bulkSync/schemas
  description: 'API Reference — subpackage_bulkSync.subpackage_bulkSync/schemas. 5 operations. Lead operation: Get Bulk Sync
    Schemas. Self-contained Naftiko capability covering one Polytomic business surface.'
  tags:
  - Polytomic
  - subpackage_bulkSync.subpackage_bulkSync/schemas
  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-bulksync-subpackage-bulksync-schemas
    baseUri: https://app.polytomic.com
    description: API Reference — subpackage_bulkSync.subpackage_bulkSync/schemas business capability. Self-contained, no shared
      references.
    resources:
    - name: api-bulk-syncs-id-schemas
      path: /api/bulk/syncs/{id}/schemas
      operations:
      - name: list
        method: GET
        description: Get Bulk Sync Schemas
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Unique identifier of the bulk sync.
          required: true
        - name: filters
          in: query
          type: object
          description: Optional filters applied to the returned schemas. Supports enabled=true to return only enabled schemas
            and enabled=false to return only disabled schemas.
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
      - name: patch
        method: PATCH
        description: Update Bulk Sync Schemas
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Unique identifier of the bulk sync.
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-bulk-syncs-id-schemas-schema_id
      path: /api/bulk/syncs/{id}/schemas/{schema_id}
      operations:
      - name: get
        method: GET
        description: Get Bulk Sync Schema
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Unique identifier of the bulk sync.
          required: true
        - name: schema_id
          in: path
          type: string
          description: Source-side schema identifier.
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
      - name: update
        method: PUT
        description: Update Bulk Sync Schema
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Unique identifier of the bulk sync.
          required: true
        - name: schema_id
          in: path
          type: string
          description: Source-side schema identifier.
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-bulk-syncs-id-schemas-schema_id-cancel
      path: /api/bulk/syncs/{id}/schemas/{schema_id}/cancel
      operations:
      - name: cancel
        method: POST
        description: Cancel Bulk Sync Schema
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The bulk sync ID.
          required: true
        - name: schema_id
          in: path
          type: string
          description: The schema ID to cancel for the bulk sync.
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user 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-bulksync-subpackage-bulksync-schemas-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_bulkSync.subpackage_bulkSync/schemas. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/bulk/syncs/{id}/schemas
      name: api-bulk-syncs-id-schemas
      description: REST surface for api-bulk-syncs-id-schemas.
      operations:
      - method: GET
        name: list
        description: Get Bulk Sync Schemas
        call: polytomic-subpackage-bulksync-subpackage-bulksync-schemas.list
        with:
          id: rest.id
          filters: rest.filters
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patch
        description: Update Bulk Sync Schemas
        call: polytomic-subpackage-bulksync-subpackage-bulksync-schemas.patch
        with:
          id: rest.id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/bulk/syncs/{id}/schemas/{schema-id}
      name: api-bulk-syncs-id-schemas-schema-id
      description: REST surface for api-bulk-syncs-id-schemas-schema_id.
      operations:
      - method: GET
        name: get
        description: Get Bulk Sync Schema
        call: polytomic-subpackage-bulksync-subpackage-bulksync-schemas.get
        with:
          id: rest.id
          schema_id: rest.schema_id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: update
        description: Update Bulk Sync Schema
        call: polytomic-subpackage-bulksync-subpackage-bulksync-schemas.update
        with:
          id: rest.id
          schema_id: rest.schema_id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/bulk/syncs/{id}/schemas/{schema-id}/cancel
      name: api-bulk-syncs-id-schemas-schema-id-cancel
      description: REST surface for api-bulk-syncs-id-schemas-schema_id-cancel.
      operations:
      - method: POST
        name: cancel
        description: Cancel Bulk Sync Schema
        call: polytomic-subpackage-bulksync-subpackage-bulksync-schemas.cancel
        with:
          id: rest.id
          schema_id: rest.schema_id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: polytomic-subpackage-bulksync-subpackage-bulksync-schemas-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_bulkSync.subpackage_bulkSync/schemas. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: get-bulk-sync-schemas
      description: Get Bulk Sync Schemas
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-bulksync-subpackage-bulksync-schemas.list
      with:
        id: tools.id
        filters: tools.filters
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: update-bulk-sync-schemas
      description: Update Bulk Sync Schemas
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: polytomic-subpackage-bulksync-subpackage-bulksync-schemas.patch
      with:
        id: tools.id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-bulk-sync-schema
      description: Get Bulk Sync Schema
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-bulksync-subpackage-bulksync-schemas.get
      with:
        id: tools.id
        schema_id: tools.schema_id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: update-bulk-sync-schema
      description: Update Bulk Sync Schema
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: polytomic-subpackage-bulksync-subpackage-bulksync-schemas.update
      with:
        id: tools.id
        schema_id: tools.schema_id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-bulk-sync-schema
      description: Cancel Bulk Sync Schema
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: polytomic-subpackage-bulksync-subpackage-bulksync-schemas.cancel
      with:
        id: tools.id
        schema_id: tools.schema_id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.