# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Search Synonyms API
  version: 1.0.0
extends: openapi/optimizely-search-synonyms-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/api/v1/admin/SearchSynonyms'].get
  update:
    x-apievangelist-phrasing:
      intent: List catalog search synonyms
      effect: read
      questions:
      - Which search synonyms are configured for the storefront catalog?
      - How do I list every word-to-synonym mapping in admin?
      instructions:
      - text: List all catalog search synonyms.
      - text: Show every configured search synonym pair.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchSynonyms'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a catalog search synonym
      effect: write
      questions:
      - How do I make product search treat two words as the same?
      - Can a new search synonym work in both directions?
      instructions:
      - text: Add search synonym {synonym} for the word {word}.
        slots:
          synonym: requestBody.synonym
          word: requestBody.word
      - text: Create a synonym mapping {word} to {synonym}, bidirectional {bidirectional}.
        slots:
          word: requestBody.word
          synonym: requestBody.synonym
          bidirectional: requestBody.bidirectional
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchSynonyms({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one catalog search synonym
      effect: read
      questions:
      - Is there a call to read a single search synonym entry?
      - Is a particular synonym mapping bidirectional?
      instructions:
      - text: Get search synonym {id}.
        slots:
          id: path.id
      - text: Show the word and synonym on entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchSynonyms({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a catalog search synonym
      effect: write
      questions:
      - What's the call to overwrite a search synonym entry in full?
      - Do I need to send both the word and synonym when replacing an entry?
      instructions:
      - text: Replace synonym entry {id} with word {word} and synonym {synonym}.
        slots:
          id: path.id
          word: requestBody.word
          synonym: requestBody.synonym
      - text: Overwrite synonym {id} in full for language {languageId}.
        slots:
          id: path.id
          languageId: requestBody.languageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchSynonyms({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a catalog search synonym
      effect: destructive
      questions:
      - How do I remove one search synonym so words stop matching?
      - Can I delete a synonym only if its ETag matches?
      instructions:
      - text: Delete search synonym {id}.
        slots:
          id: path.id
      - text: Delete synonym entry {id} if ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchSynonyms({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a catalog search synonym
      effect: write
      questions:
      - How do I make an existing synonym one-way only?
      - Can I change just the synonym word on an existing entry?
      instructions:
      - text: Set bidirectional on synonym {id} to {bidirectional}.
        slots:
          id: path.id
          bidirectional: requestBody.bidirectional
      - text: Change the synonym on entry {id} to {synonym}.
        slots:
          id: path.id
          synonym: requestBody.synonym
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchSynonyms/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default search synonym template
      effect: read
      questions:
      - What does a default search synonym record contain?
      - Where do I get blank values for a new synonym entry?
      instructions:
      - text: Get the default search synonym template.
      - text: Show default fields for a new catalog synonym.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/searchsynonyms/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete catalog search synonyms
      effect: destructive
      questions:
      - Can I remove many search synonyms at once?
      - Can I bulk delete synonym entries by ID?
      instructions:
      - text: Bulk delete search synonyms {ids}.
        slots:
          ids: query.ids
      - text: 'Remove all these synonym entries: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/searchsynonyms({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a search synonym
      effect: read
      questions:
      - Where would I read a custom property on a search synonym?
      - Can I fetch an extra attribute stored on a synonym entry?
      instructions:
      - text: Get custom property {prop} on search synonym {key}.
        slots:
          key: path.key
          prop: path.custompropertyKey
      - text: Show custom field {prop} for search synonym {key}.
        slots:
          key: path.key
          prop: path.custompropertyKey
      method: generated
      generated: '2026-09-26'