Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Website Countries API

10 actions 10 updates phrasing extends openapi/optimizely-website-countries-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Optimizely's API. It is a proposal applied on top of the contract, not a document Optimizely publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/api/v1/admin/WebsiteCountries'].get
$.paths['/api/v1/admin/WebsiteCountries'].post
$.paths['/api/v1/admin/WebsiteCountries({id})'].get
$.paths['/api/v1/admin/WebsiteCountries({id})'].put
$.paths['/api/v1/admin/WebsiteCountries({id})'].delete
$.paths['/api/v1/admin/WebsiteCountries({id})'].patch
$.paths['/api/v1/admin/WebsiteCountries/Default.Default()'].get
$.paths['/api/v1/admin/websitecountries/delete'].delete
$.paths['/api/v1/admin/websitecountries({key})/customproperties({custompropertyKey})'].get

OpenAPI Overlay

Raw ↑
# 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 Countries API
  version: 1.0.0
extends: openapi/optimizely-website-countries-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/WebsiteCountries'].get
  update:
    x-apievangelist-phrasing:
      intent: List countries enabled on websites
      effect: read
      questions:
      - Which countries are enabled on each of my commerce websites?
      - Can I filter website-country links to one website?
      instructions:
      - text: List all website countries.
      - text: List website countries where {filter}.
        slots:
          filter: query.$filter
      - text: Return the first {top} website countries sorted by {orderby}.
        slots:
          top: query.$top
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteCountries'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable a country on a website
      effect: write
      questions:
      - How do I make a new country available on one of my websites?
      - Can I link a country to a website so shoppers there can check out?
      instructions:
      - text: Enable country {countryId} on website {websiteId}.
        slots:
          countryId: requestBody.countryId
          websiteId: requestBody.websiteId
      - text: Add a website country link for website {websiteId} and country {countryId}.
        slots:
          websiteId: requestBody.websiteId
          countryId: requestBody.countryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteCountries({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a website country link by id
      effect: read
      questions:
      - Which website and country does one website-country record connect?
      - Can I look up a single website country by id?
      instructions:
      - text: Get website country {id}.
        slots:
          id: path.id
      - text: Fetch website country {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteCountries({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a website country link
      effect: write
      questions:
      - How do I overwrite a website-country record entirely?
      - What does a full replacement of a website country need?
      instructions:
      - text: Replace website country {id} with website {websiteId} and country {countryId}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
          countryId: requestBody.countryId
      - text: Overwrite the full website country record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteCountries({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a country from a website
      effect: destructive
      questions:
      - Can I stop offering a country on a website by deleting its link?
      - Does deleting a website country accept an If-Match ETag?
      instructions:
      - text: Delete website country {id}.
        slots:
          id: path.id
      - text: Delete website country {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/WebsiteCountries({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change the country on a website link
      effect: write
      questions:
      - How do I point an existing website-country link at a different country?
      - Can I move a website country record to another website without a full replace?
      instructions:
      - text: Change website country {id} to country {countryId}.
        slots:
          id: path.id
          countryId: requestBody.countryId
      - text: Move website country {id} to website {websiteId}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteCountries/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank website country template
      effect: read
      questions:
      - What default values does a new website country link start with?
      - Is there an empty website country template to fill in?
      instructions:
      - text: Get the default website country template.
      - text: Show the defaults for a new website country.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/websitecountries/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete website country links
      effect: destructive
      questions:
      - Can I remove several website-country links in one request?
      - How do I delete a list of website countries by id?
      instructions:
      - text: Bulk delete website countries {ids}.
        slots:
          ids: query.ids
      - text: Remove the website countries with ids {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/websitecountries({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of a website country
      effect: read
      questions:
      - What custom property values are stored on a website country?
      - Can I read one extension field from a website country link?
      instructions:
      - text: Get custom property {custompropertyKey} of website country {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Read custom field {custompropertyKey} on website country {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'