Platform API — Custom data type

naftiko: 1.0.0-alpha2
info:
  label: Platform API — Custom data type
  description: 'Platform API — Custom data type. 4 operations. Lead operation: List custom data type records. Self-contained
    Naftiko capability covering one Codat business surface.'
  tags:
  - Codat
  - Custom data type
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CODAT_API_KEY: CODAT_API_KEY
capability:
  consumes:
  - type: http
    namespace: platform-custom-data-type
    baseUri: https://api.codat.io
    description: Platform API — Custom data type business capability. Self-contained, no shared references.
    resources:
    - name: companies-companyId-connections-connectionId-data-custom-customDataIdentifier
      path: /companies/{companyId}/connections/{connectionId}/data/custom/{customDataIdentifier}
      operations:
      - name: listcustomdatatyperecords
        method: GET
        description: List custom data type records
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: companies-companyId-connections-connectionId-data-queue-custom-customDataIdentif
      path: /companies/{companyId}/connections/{connectionId}/data/queue/custom/{customDataIdentifier}
      operations:
      - name: refreshcustomdatatype
        method: POST
        description: Refresh custom data type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: integrations-platformKey-dataTypes-custom-customDataIdentifier
      path: /integrations/{platformKey}/dataTypes/custom/{customDataIdentifier}
      operations:
      - name: configurecustomdatatype
        method: PUT
        description: Configure custom data type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getcustomdatatypeconfiguration
        method: GET
        description: Get custom data configuration
        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-custom-data-type-rest
    port: 8080
    description: REST adapter for Platform API — Custom data type. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/companies/{companyid}/connections/{connectionid}/data/custom/{customdataidentifier}
      name: companies-companyid-connections-connectionid-data-custom-customdataidentifier
      description: REST surface for companies-companyId-connections-connectionId-data-custom-customDataIdentifier.
      operations:
      - method: GET
        name: listcustomdatatyperecords
        description: List custom data type records
        call: platform-custom-data-type.listcustomdatatyperecords
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/companies/{companyid}/connections/{connectionid}/data/queue/custom/{customdataidentifier}
      name: companies-companyid-connections-connectionid-data-queue-custom-customdataidentif
      description: REST surface for companies-companyId-connections-connectionId-data-queue-custom-customDataIdentif.
      operations:
      - method: POST
        name: refreshcustomdatatype
        description: Refresh custom data type
        call: platform-custom-data-type.refreshcustomdatatype
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/integrations/{platformkey}/datatypes/custom/{customdataidentifier}
      name: integrations-platformkey-datatypes-custom-customdataidentifier
      description: REST surface for integrations-platformKey-dataTypes-custom-customDataIdentifier.
      operations:
      - method: PUT
        name: configurecustomdatatype
        description: Configure custom data type
        call: platform-custom-data-type.configurecustomdatatype
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getcustomdatatypeconfiguration
        description: Get custom data configuration
        call: platform-custom-data-type.getcustomdatatypeconfiguration
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-custom-data-type-mcp
    port: 9090
    transport: http
    description: MCP adapter for Platform API — Custom data type. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-custom-data-type-records
      description: List custom data type records
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-custom-data-type.listcustomdatatyperecords
      outputParameters:
      - type: object
        mapping: $.
    - name: refresh-custom-data-type
      description: Refresh custom data type
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-custom-data-type.refreshcustomdatatype
      outputParameters:
      - type: object
        mapping: $.
    - name: configure-custom-data-type
      description: Configure custom data type
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: platform-custom-data-type.configurecustomdatatype
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-custom-data-configuration
      description: Get custom data configuration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-custom-data-type.getcustomdatatypeconfiguration
      outputParameters:
      - type: object
        mapping: $.