# 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 Html Redirects API
  version: 1.0.0
extends: openapi/optimizely-html-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: 9
- target: $.paths['/api/v1/admin/HtmlRedirects'].get
  update:
    x-apievangelist-phrasing:
      intent: List URL redirects
      effect: read
      questions:
      - Which old URLs are currently redirected on my storefront?
      - Can I filter redirects to find where a particular old URL points?
      instructions:
      - text: List all HTML redirects.
      - text: List redirects matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/HtmlRedirects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a URL redirect
      effect: write
      questions:
      - How do I redirect an old page URL to a new one?
      - What do I need to set up a redirect - just the old and new URL?
      instructions:
      - text: Redirect {oldUrl} to {newUrl}.
        slots:
          oldUrl: requestBody.oldUrl
          newUrl: requestBody.newUrl
      - text: Add a new redirect sending visitors from {oldUrl} to {newUrl}.
        slots:
          oldUrl: requestBody.oldUrl
          newUrl: requestBody.newUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/HtmlRedirects({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one URL redirect
      effect: read
      questions:
      - How do I look up a single redirect rule by its ID?
      - Can I see just the old and new URL of one redirect?
      instructions:
      - text: Get redirect {id}.
        slots:
          id: path.id
      - text: Show fields {select} of redirect {id}.
        slots:
          select: query.$select
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/HtmlRedirects({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a URL redirect
      effect: write
      questions:
      - How do I overwrite a redirect rule with both new source and target URLs?
      - Does replacing a redirect require sending the old and new URL again?
      instructions:
      - text: Replace redirect {id} so {oldUrl} goes to {newUrl}.
        slots:
          id: path.id
          oldUrl: requestBody.oldUrl
          newUrl: requestBody.newUrl
      - text: Fully overwrite redirect rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/HtmlRedirects({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a URL redirect
      effect: destructive
      questions:
      - How do I stop redirecting an old URL?
      - Can I delete a redirect only if it hasn't changed since I read it?
      instructions:
      - text: Delete redirect {id}.
        slots:
          id: path.id
      - text: Delete redirect {id} if its ETag is {ifMatch}.
        slots:
          id: path.id
          ifMatch: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/HtmlRedirects({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a redirect's target URL
      effect: write
      questions:
      - Can I point an existing redirect at a different destination?
      - How do I change only the source URL of a redirect rule?
      instructions:
      - text: Point redirect {id} at {newUrl} instead.
        slots:
          id: path.id
          newUrl: requestBody.newUrl
      - text: Change the source of redirect {id} to {oldUrl}.
        slots:
          id: path.id
          oldUrl: requestBody.oldUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/HtmlRedirects/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Call the Default function on redirects
      effect: read
      questions:
      - What does the Default OData function on HTML redirects return?
      - Is there a default redirect entity I can use as a template?
      instructions:
      - text: Call the Default function on HTML redirects.
      - text: Get the default HTML redirect entity.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/htmlredirects/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete URL redirects
      effect: destructive
      questions:
      - Can I remove many redirect rules in one request after a site migration?
      - How do I delete a list of redirects by their IDs?
      instructions:
      - text: Bulk delete redirects {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these redirect rules together: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/htmlredirects({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a redirect
      effect: read
      questions:
      - How do I read a custom property stored on a redirect rule?
      - Can redirects carry custom fields I can fetch individually?
      instructions:
      - text: Get custom property {custompropertyKey} of redirect {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Read custom field {custompropertyKey} on redirect rule {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'