Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Website Currencies API

10 actions 10 updates phrasing extends openapi/optimizely-website-currencies-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/WebsiteCurrencies'].get
$.paths['/api/v1/admin/WebsiteCurrencies'].post
$.paths['/api/v1/admin/WebsiteCurrencies({id})'].get
$.paths['/api/v1/admin/WebsiteCurrencies({id})'].put
$.paths['/api/v1/admin/WebsiteCurrencies({id})'].delete
$.paths['/api/v1/admin/WebsiteCurrencies({id})'].patch
$.paths['/api/v1/admin/WebsiteCurrencies/Default.Default()'].get
$.paths['/api/v1/admin/websitecurrencies/delete'].delete
$.paths['/api/v1/admin/websitecurrencies({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 Currencies API
  version: 1.0.0
extends: openapi/optimizely-website-currencies-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/WebsiteCurrencies'].get
  update:
    x-apievangelist-phrasing:
      intent: List currencies enabled on websites
      effect: read
      questions:
      - Which currencies can shoppers use on each storefront website?
      - Can I filter website currencies to only the live ones?
      instructions:
      - text: List all website currencies.
      - text: List website currencies matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteCurrencies'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable a currency on a website
      effect: write
      questions:
      - How do I add a currency to a storefront website?
      - Can I make a newly added currency the site default?
      instructions:
      - text: Add currency {currencyId} to website {websiteId}.
        slots:
          currencyId: requestBody.currencyId
          websiteId: requestBody.websiteId
      - text: Enable currency {currencyId} on website {websiteId} with live set to {isLive} and default {isDefault}.
        slots:
          currencyId: requestBody.currencyId
          websiteId: requestBody.websiteId
          isLive: requestBody.isLive
          isDefault: requestBody.isDefault
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteCurrencies({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a website currency
      effect: read
      questions:
      - Can I look up one website currency assignment by ID?
      - Is a given website currency live or the default?
      instructions:
      - text: Show website currency {id}.
        slots:
          id: path.id
      - text: Get website currency {id} expanding {expand}.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteCurrencies({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a website currency
      effect: write
      questions:
      - Can I overwrite a website currency record completely?
      - What's the full-replace call for a website currency?
      instructions:
      - text: Replace website currency {id} with currency {currencyId} on website {websiteId}.
        slots:
          id: path.id
          currencyId: requestBody.currencyId
          websiteId: requestBody.websiteId
      - text: Overwrite website currency {id}, setting default to {isDefault}.
        slots:
          id: path.id
          isDefault: requestBody.isDefault
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteCurrencies({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a currency from a website
      effect: destructive
      questions:
      - How do I stop offering a currency on a website?
      - Can I delete a website currency only if its ETag matches?
      instructions:
      - text: Delete website currency {id}.
        slots:
          id: path.id
      - text: Delete website currency {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/WebsiteCurrencies({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Make a website currency live or default
      effect: write
      questions:
      - Can I switch a website currency live without resending the rest?
      - Is there a partial update to change the default currency flag?
      instructions:
      - text: Set website currency {id} live to {isLive}.
        slots:
          id: path.id
          isLive: requestBody.isLive
      - text: Patch website currency {id} so default is {isDefault}.
        slots:
          id: path.id
          isDefault: requestBody.isDefault
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteCurrencies/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a website currency
      effect: read
      questions:
      - What defaults are pre-filled for a new website currency?
      - Is there a blank website currency template?
      instructions:
      - text: Get the default website currency template.
      - text: Show pre-filled values for a new website currency.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/websitecurrencies/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove several website currencies
      effect: destructive
      questions:
      - Can I bulk delete website currencies in one call?
      - Which call removes many website currency records by ID?
      instructions:
      - text: Bulk delete website currencies {ids}.
        slots:
          ids: query.ids
      - text: Remove the website currency records {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/websitecurrencies({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a website currency
      effect: read
      questions:
      - Can I read a custom field stored on a website currency?
      - Where are extra attributes of a website currency kept?
      instructions:
      - text: Get custom property {custompropertyKey} on website currency {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show website currency {key}'s custom field {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'