# 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 Website States API
  version: 1.0.0
extends: openapi/optimizely-website-states-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/WebsiteStates'].get
  update:
    x-apievangelist-phrasing:
      intent: List website state assignments
      effect: read
      questions:
      - Which states or provinces are enabled on each of my commerce websites?
      - Can I filter website states to one website?
      - How many website-to-state assignments exist?
      instructions:
      - text: List all website states.
      - text: List website states matching {filter}.
        slots:
          filter: query.$filter
      - text: Show the first {top} website states ordered by {orderby}.
        slots:
          top: query.$top
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteStates'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable a state on a website
      effect: write
      questions:
      - How do I make a state or province available on a website?
      - Can I link a state to a specific commerce website?
      instructions:
      - text: Enable state {stateId} on website {websiteId}.
        slots:
          stateId: requestBody.stateId
          websiteId: requestBody.websiteId
      - text: Assign state {stateId} to website {websiteId} as a new website state.
        slots:
          stateId: requestBody.stateId
          websiteId: requestBody.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteStates({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a website state assignment
      effect: read
      questions:
      - Which website and state does one website state record link?
      - Can I fetch a single website state by ID?
      instructions:
      - text: Get website state {id}.
        slots:
          id: path.id
      - text: Show the website and state linked by record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteStates({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a website state assignment
      effect: write
      questions:
      - How do I overwrite a website state record completely?
      - Does replacing a website state reset the fields I omit?
      instructions:
      - text: Replace website state {id} so it links website {websiteId} and state {stateId}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
          stateId: requestBody.stateId
      - text: Overwrite all fields of website state {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteStates({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a state from a website
      effect: destructive
      questions:
      - Can I stop offering a state on a website by deleting its record?
      - Is it possible to delete a website state only if its ETag matches?
      instructions:
      - text: Delete website state {id}.
        slots:
          id: path.id
      - text: Delete website state {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/WebsiteStates({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a website state assignment
      effect: write
      questions:
      - How do I point an existing website state record at a different state?
      - Can I move a website state assignment to another website?
      instructions:
      - text: Change website state {id} to state {stateId}.
        slots:
          id: path.id
          stateId: requestBody.stateId
      - text: Move website state {id} to website {websiteId}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteStates/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank website state template
      effect: read
      questions:
      - What default values does a new website state record have?
      - Can I fetch an empty website state template?
      instructions:
      - text: Fetch the default website state template.
      - text: Show the starting values for a new website state.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/websitestates/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete website states
      effect: destructive
      questions:
      - Can I remove several states from websites at once?
      - How do I bulk delete website state records by ID?
      instructions:
      - text: Bulk delete website states {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these website state records together: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/websitestates({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a website state
      effect: read
      questions:
      - Can I read a custom property stored on a website state?
      - What extra custom values does a website state record carry?
      instructions:
      - text: Get custom property {custompropertyKey} on website state {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show website state {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'