Platform API — Push data

naftiko: 1.0.0-alpha2
info:
  label: Platform API — Push data
  description: 'Platform API — Push data. 3 operations. Lead operation: Get push options. Self-contained Naftiko capability
    covering one Codat business surface.'
  tags:
  - Codat
  - Push data
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CODAT_API_KEY: CODAT_API_KEY
capability:
  consumes:
  - type: http
    namespace: platform-push-data
    baseUri: https://api.codat.io
    description: Platform API — Push data business capability. Self-contained, no shared references.
    resources:
    - name: companies-companyId-connections-connectionId-options-dataType
      path: /companies/{companyId}/connections/{connectionId}/options/{dataType}
      operations:
      - name: getcreateupdatemodeloptionsbydatatype
        method: GET
        description: Get push options
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: companies-companyId-push
      path: /companies/{companyId}/push
      operations:
      - name: getcompanypushhistory
        method: GET
        description: List push operations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: companies-companyId-push-pushOperationKey
      path: /companies/{companyId}/push/{pushOperationKey}
      operations:
      - name: getpushoperation
        method: GET
        description: Get push operation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.CODAT_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: platform-push-data-rest
    port: 8080
    description: REST adapter for Platform API — Push data. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/companies/{companyid}/connections/{connectionid}/options/{datatype}
      name: companies-companyid-connections-connectionid-options-datatype
      description: REST surface for companies-companyId-connections-connectionId-options-dataType.
      operations:
      - method: GET
        name: getcreateupdatemodeloptionsbydatatype
        description: Get push options
        call: platform-push-data.getcreateupdatemodeloptionsbydatatype
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/companies/{companyid}/push
      name: companies-companyid-push
      description: REST surface for companies-companyId-push.
      operations:
      - method: GET
        name: getcompanypushhistory
        description: List push operations
        call: platform-push-data.getcompanypushhistory
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/companies/{companyid}/push/{pushoperationkey}
      name: companies-companyid-push-pushoperationkey
      description: REST surface for companies-companyId-push-pushOperationKey.
      operations:
      - method: GET
        name: getpushoperation
        description: Get push operation
        call: platform-push-data.getpushoperation
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-push-data-mcp
    port: 9090
    transport: http
    description: MCP adapter for Platform API — Push data. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-push-options
      description: Get push options
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-push-data.getcreateupdatemodeloptionsbydatatype
      outputParameters:
      - type: object
        mapping: $.
    - name: list-push-operations
      description: List push operations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-push-data.getcompanypushhistory
      outputParameters:
      - type: object
        mapping: $.
    - name: get-push-operation
      description: Get push operation
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-push-data.getpushoperation
      outputParameters:
      - type: object
        mapping: $.