# 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 Term Redirects API
  version: 1.0.0
extends: openapi/optimizely-search-term-redirects-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: 11
- target: $.paths['/api/v1/admin/SearchTermRedirects'].get
  update:
    x-apievangelist-phrasing:
      intent: List search term redirects
      effect: read
      questions:
      - Which search terms currently redirect shoppers to another page?
      - Can I filter search term redirects by the term itself?
      instructions:
      - text: List all search term redirects.
      - text: Show search term redirects matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchTermRedirects'].post
  update:
    x-apievangelist-phrasing:
      intent: Redirect a search term to a page
      effect: write
      questions:
      - How do I send shoppers who search a certain word straight to a specific page?
      - Can a search redirect be scheduled to start and stop on set dates?
      instructions:
      - text: Redirect searches for {term} to {redirectUri}.
        slots:
          term: requestBody.term
          redirectUri: requestBody.redirectUri
      - text: Create a redirect for search term {term} to {redirectUri} starting {activateOn}.
        slots:
          term: requestBody.term
          redirectUri: requestBody.redirectUri
          activateOn: requestBody.activateOn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchTermRedirects({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one search term redirect
      effect: read
      questions:
      - How do I look up a single search redirect by id?
      - Where does a specific search term redirect point?
      instructions:
      - text: Fetch search term redirect {id}.
        slots:
          id: path.id
      - text: Show the target URL of search redirect {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchTermRedirects({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a search term redirect
      effect: write
      questions:
      - Can I fully replace an existing search redirect's term and target?
      - Does replacing a search redirect reset its activation dates?
      instructions:
      - text: Replace redirect {id} so {term} goes to {redirectUri}.
        slots:
          id: path.id
          term: requestBody.term
          redirectUri: requestBody.redirectUri
      - text: Overwrite the whole search redirect record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchTermRedirects({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single search term redirect
      effect: destructive
      questions:
      - How do I stop one search term from redirecting?
      - Can I delete a search redirect only if nobody else changed it?
      instructions:
      - text: Delete search term redirect {id}.
        slots:
          id: path.id
      - text: Remove search redirect {id} if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchTermRedirects({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change where a search term redirects
      effect: write
      questions:
      - Can I point an existing search redirect at a new URL?
      - Is there a way to set an end date on a search redirect I already made?
      instructions:
      - text: Point search redirect {id} to {redirectUri}.
        slots:
          id: path.id
          redirectUri: requestBody.redirectUri
      - text: Deactivate search redirect {id} on {deactivateOn}.
        slots:
          id: path.id
          deactivateOn: requestBody.deactivateOn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchTermRedirects/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new search redirect
      effect: read
      questions:
      - What defaults does a new search term redirect start with?
      - Is there a blank search redirect template?
      instructions:
      - text: Get the default values for a new search term redirect.
      - text: Show the empty search redirect record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SearchTermRedirects/Default.archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive search redirects via the OData action
      effect: destructive
      questions:
      - How do I archive search redirects with the OData Default.archive action?
      - Can I retire old search redirects using the archive action call?
      instructions:
      - text: Run the OData archive action on search redirects {ids}.
        slots:
          ids: query.ids
      - text: Archive search term redirects {ids} with Default.archive.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/searchtermredirects/archive'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive search redirects through the archive route
      effect: destructive
      questions:
      - Is there a REST route to archive a batch of search redirects?
      - What does a DELETE on searchtermredirects/archive do?
      instructions:
      - text: Archive search redirects {ids} via the searchtermredirects/archive route.
        slots:
          ids: query.ids
      - text: Send the batch archive request for search redirects {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/searchtermredirects/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete several search redirects
      effect: destructive
      questions:
      - How do I bulk delete search term redirects?
      - Can I permanently remove a list of search redirects at once?
      instructions:
      - text: Bulk delete search term redirects {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every search redirect in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/searchtermredirects({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a search redirect
      effect: read
      questions:
      - How do I read a custom property on a search term redirect?
      - Can I fetch one custom field from a search redirect?
      instructions:
      - text: Get custom property {custompropertyKey} of search redirect {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show the {custompropertyKey} custom property on search term redirect {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'