Coveo Commerce API — Synonym Preview

naftiko: 1.0.0-alpha2
info:
  label: Coveo Commerce API — Synonym Preview
  description: 'Coveo Commerce API — Synonym Preview. 1 operations. Lead operation: Preview the Impact of a Synonym Rule.
    Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Commerce
  - Synonym Preview
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_SEARCH_TOKEN: COVEO_SEARCH_TOKEN
capability:
  consumes:
  - type: http
    namespace: commerce-synonym-preview
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Commerce API — Synonym Preview business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_SEARCH_TOKEN}}'
    resources:
    - name: rest-organizations-organizationId-commerce-v2-search-preview-synonyms-new
      path: /rest/organizations/{organizationId}/commerce/v2/search/preview/synonyms/new
      operations:
      - name: previewsynonym
        method: POST
        description: Preview the Impact of a Synonym Rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `acmecorporation8tp8wu3`
          required: true
        - name: trackingId
          in: query
          type: string
          description: The unique identifier of the tracking target.
          required: true
        - name: id
          in: query
          type: string
          description: A UUID identifying the synonym rule.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: commerce-synonym-preview-rest
    port: 8080
    description: REST adapter for Coveo Commerce API — Synonym Preview. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/commerce/v2/search/preview/synonyms/new
      name: rest-organizations-organizationid-commerce-v2-search-preview-synonyms-new
      description: REST surface for rest-organizations-organizationId-commerce-v2-search-preview-synonyms-new.
      operations:
      - method: POST
        name: previewsynonym
        description: Preview the Impact of a Synonym Rule
        call: commerce-synonym-preview.previewsynonym
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: commerce-synonym-preview-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Commerce API — Synonym Preview. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: preview-impact-synonym-rule
      description: Preview the Impact of a Synonym Rule
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: commerce-synonym-preview.previewsynonym
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.