# 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 Stopwords API
  version: 1.0.0
extends: openapi/optimizely-search-stopwords-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/SearchStopwords'].get
  update:
    x-apievangelist-phrasing:
      intent: List search stopwords
      effect: read
      questions:
      - Which words does the storefront search ignore as stopwords?
      - Can I filter the stopword list to one language?
      instructions:
      - text: List search stopwords matching {filter}.
        slots:
          filter: query.$filter
      - text: Show all search stopwords sorted by {orderby}.
        slots:
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchStopwords'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a search stopword
      effect: write
      questions:
      - How do I make site search ignore a word like 'the' or 'and'?
      - Can I add a stopword that only applies to one language?
      instructions:
      - text: Add search stopword {word}.
        slots:
          word: requestBody.word
      - text: Add stopword {word} for language {languageId}.
        slots:
          word: requestBody.word
          languageId: requestBody.languageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchStopwords({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one search stopword
      effect: read
      questions:
      - Where do I look up a single stopword record by id?
      - What word and language does a given stopword record hold?
      instructions:
      - text: Get search stopword {id}.
        slots:
          id: path.id
      - text: Show the word and language of stopword record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchStopwords({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a search stopword
      effect: write
      questions:
      - How do I fully overwrite a stopword record?
      - Does replacing a stopword require sending the word again?
      instructions:
      - text: Replace stopword {id} with the word {word}.
        slots:
          id: path.id
          word: requestBody.word
      - text: Overwrite stopword record {id} with word {word} in language {languageId}.
        slots:
          id: path.id
          word: requestBody.word
          languageId: requestBody.languageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchStopwords({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a search stopword
      effect: destructive
      questions:
      - Can I let search match a word again by deleting its stopword?
      - Is an If-Match ETag accepted when deleting a stopword?
      instructions:
      - text: Delete search stopword {id}.
        slots:
          id: path.id
      - text: Delete stopword {id} only if ETag {etag} matches.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchStopwords({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a search stopword
      effect: write
      questions:
      - Can I change the language of an existing stopword without replacing it?
      - How do I correct a misspelled stopword in place?
      instructions:
      - text: Change the language of stopword {id} to {languageId}.
        slots:
          id: path.id
          languageId: requestBody.languageId
      - text: Correct stopword {id} to read {word}.
        slots:
          id: path.id
          word: requestBody.word
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchStopwords/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Call the Default function on search stopwords
      effect: read
      questions:
      - What does the Default function on SearchStopwords return?
      - Where do I get the default search stopword entity?
      instructions:
      - text: Call the Default function on SearchStopwords.
      - text: Fetch the default search stopword entity.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/searchstopwords/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete search stopwords
      effect: destructive
      questions:
      - Can I remove many stopwords at once by id?
      - Is there a bulk way to clear out search stopwords?
      instructions:
      - text: Bulk delete search stopwords {ids}.
        slots:
          ids: query.ids
      - text: Remove every stopword in the id list {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/searchstopwords({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a search stopword
      effect: read
      questions:
      - How do I read a custom property stored on a stopword?
      - Can I fetch one extension field from a stopword record?
      instructions:
      - text: Get custom property {custompropertyKey} of stopword {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show custom field {custompropertyKey} on search stopword {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'