Basiq API — Connections

naftiko: 1.0.0-alpha2
info:
  label: Basiq API — Connections
  description: 'Basiq API — Connections. 4 operations. Lead operation: List Connections. Self-contained Naftiko capability
    covering one Basiq business surface.'
  tags:
  - Basiq
  - Connections
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BASIQ_API_KEY: BASIQ_API_KEY
capability:
  consumes:
  - type: http
    namespace: basiq-connections
    baseUri: https://au-api.basiq.io
    description: Basiq API — Connections business capability. Self-contained, no shared references.
    resources:
    - name: users-userId-connections
      path: /users/{userId}/connections
      operations:
      - name: listconnections
        method: GET
        description: List Connections
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createconnection
        method: POST
        description: Create Connection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: users-userId-connections-connectionId
      path: /users/{userId}/connections/{connectionId}
      operations:
      - name: getconnection
        method: GET
        description: Get Connection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteconnection
        method: DELETE
        description: Delete Connection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.BASIQ_API_KEY}}'
  exposes:
  - type: rest
    namespace: basiq-connections-rest
    port: 8080
    description: REST adapter for Basiq API — Connections. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/users/{userid}/connections
      name: users-userid-connections
      description: REST surface for users-userId-connections.
      operations:
      - method: GET
        name: listconnections
        description: List Connections
        call: basiq-connections.listconnections
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createconnection
        description: Create Connection
        call: basiq-connections.createconnection
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{userid}/connections/{connectionid}
      name: users-userid-connections-connectionid
      description: REST surface for users-userId-connections-connectionId.
      operations:
      - method: GET
        name: getconnection
        description: Get Connection
        call: basiq-connections.getconnection
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteconnection
        description: Delete Connection
        call: basiq-connections.deleteconnection
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: basiq-connections-mcp
    port: 9090
    transport: http
    description: MCP adapter for Basiq API — Connections. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-connections
      description: List Connections
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: basiq-connections.listconnections
      outputParameters:
      - type: object
        mapping: $.
    - name: create-connection
      description: Create Connection
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: basiq-connections.createconnection
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-connection
      description: Get Connection
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: basiq-connections.getconnection
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-connection
      description: Delete Connection
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: basiq-connections.deleteconnection
      outputParameters:
      - type: object
        mapping: $.