Sitecore Personalize REST API — Connections

naftiko: 1.0.0-alpha2
info:
  label: Sitecore Personalize REST API — Connections
  description: 'Sitecore Personalize REST API — Connections. 5 operations. Lead operation: List connections. Self-contained
    Naftiko capability covering one Sitecore business surface.'
  tags:
  - Sitecore
  - Connections
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SITECORE_API_KEY: SITECORE_API_KEY
capability:
  consumes:
  - type: http
    namespace: personalize-rest-connections
    baseUri: https://api.boxever.com
    description: Sitecore Personalize REST API — Connections business capability. Self-contained, no shared references.
    resources:
    - name: v1-connections
      path: /v1/connections
      operations:
      - name: listconnections
        method: GET
        description: List connections
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createconnection
        method: POST
        description: Create a connection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-connections-id
      path: /v1/connections/{id}
      operations:
      - name: getconnection
        method: GET
        description: Get a connection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateconnection
        method: PUT
        description: Update a connection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-connections-id-test
      path: /v1/connections/{id}/test
      operations:
      - name: testconnection
        method: POST
        description: Test a connection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.SITECORE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: personalize-rest-connections-rest
    port: 8080
    description: REST adapter for Sitecore Personalize REST API — Connections. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/v1/connections
      name: v1-connections
      description: REST surface for v1-connections.
      operations:
      - method: GET
        name: listconnections
        description: List connections
        call: personalize-rest-connections.listconnections
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createconnection
        description: Create a connection
        call: personalize-rest-connections.createconnection
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/connections/{id}
      name: v1-connections-id
      description: REST surface for v1-connections-id.
      operations:
      - method: GET
        name: getconnection
        description: Get a connection
        call: personalize-rest-connections.getconnection
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateconnection
        description: Update a connection
        call: personalize-rest-connections.updateconnection
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/connections/{id}/test
      name: v1-connections-id-test
      description: REST surface for v1-connections-id-test.
      operations:
      - method: POST
        name: testconnection
        description: Test a connection
        call: personalize-rest-connections.testconnection
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: personalize-rest-connections-mcp
    port: 9090
    transport: http
    description: MCP adapter for Sitecore Personalize REST 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: personalize-rest-connections.listconnections
      outputParameters:
      - type: object
        mapping: $.
    - name: create-connection
      description: Create a connection
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: personalize-rest-connections.createconnection
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-connection
      description: Get a connection
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: personalize-rest-connections.getconnection
      outputParameters:
      - type: object
        mapping: $.
    - name: update-connection
      description: Update a connection
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: personalize-rest-connections.updateconnection
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: test-connection
      description: Test a connection
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: personalize-rest-connections.testconnection
      outputParameters:
      - type: object
        mapping: $.