CargoDocs Partner API — Common

naftiko: 1.0.0-alpha2
info:
  label: CargoDocs Partner API — Common
  description: 'CargoDocs Partner API — Common. 1 operations. Lead operation: CargoDocs Get Counterparties. Self-contained
    Naftiko capability covering one Cargodocs business surface.'
  tags:
  - Cargodocs
  - Common
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CARGODOCS_API_KEY: CARGODOCS_API_KEY
capability:
  consumes:
  - type: http
    namespace: partner-common
    baseUri: https://api-test.cargodocs.com/v3
    description: CargoDocs Partner API — Common business capability. Self-contained, no shared references.
    resources:
    - name: common-counterparties
      path: /common/counterparties
      operations:
      - name: getcounterparties
        method: GET
        description: CargoDocs Get Counterparties
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.CARGODOCS_API_KEY}}'
  exposes:
  - type: rest
    namespace: partner-common-rest
    port: 8080
    description: REST adapter for CargoDocs Partner API — Common. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/common/counterparties
      name: common-counterparties
      description: REST surface for common-counterparties.
      operations:
      - method: GET
        name: getcounterparties
        description: CargoDocs Get Counterparties
        call: partner-common.getcounterparties
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: partner-common-mcp
    port: 9090
    transport: http
    description: MCP adapter for CargoDocs Partner API — Common. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: cargodocs-get-counterparties
      description: CargoDocs Get Counterparties
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: partner-common.getcounterparties
      outputParameters:
      - type: object
        mapping: $.