Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Wish List Customer Exceptions API

10 actions 10 updates phrasing extends openapi/optimizely-wish-list-customer-exceptions-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/WishListCustomerExceptions'].get
$.paths['/api/v1/admin/WishListCustomerExceptions'].post
$.paths['/api/v1/admin/WishListCustomerExceptions({id})'].get
$.paths['/api/v1/admin/WishListCustomerExceptions({id})'].put
$.paths['/api/v1/admin/WishListCustomerExceptions({id})'].delete
$.paths['/api/v1/admin/WishListCustomerExceptions({id})'].patch
$.paths['/api/v1/admin/WishListCustomerExceptions/Default.Default()'].get
$.paths['/api/v1/admin/wishlistcustomerexceptions/delete'].delete
$.paths['/api/v1/admin/wishlistcustomerexceptions({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 Wish List Customer Exceptions API
  version: 1.0.0
extends: openapi/optimizely-wish-list-customer-exceptions-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/WishListCustomerExceptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List wish list customer exceptions
      effect: read
      questions:
      - How can I see which customers are excluded from wish lists?
      - Can I filter wish list customer exceptions to a single wish list?
      instructions:
      - text: List all wish list customer exceptions.
      - text: List wish list customer exceptions matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListCustomerExceptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Exclude a customer from a wish list
      effect: write
      questions:
      - How do I stop a customer from seeing a shared wish list?
      - Can I add a customer exception to a global wish list?
      instructions:
      - text: Exclude customer {customerId} from wish list {wishListId}.
        slots:
          customerId: requestBody.customerId
          wishListId: requestBody.wishListId
      - text: Create a customer exception for wish list {wishListId}.
        slots:
          wishListId: requestBody.wishListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListCustomerExceptions({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one wish list customer exception
      effect: read
      questions:
      - How can I look up a single wish list customer exception?
      - Which customer and wish list does an exception record point to?
      instructions:
      - text: Show wish list customer exception {id}.
        slots:
          id: path.id
      - text: Fetch {select} for customer exception {id}.
        slots:
          id: path.id
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListCustomerExceptions({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a wish list customer exception
      effect: write
      questions:
      - How do I overwrite a wish list customer exception record?
      - Does a full replace of an exception clear the customer if omitted?
      instructions:
      - text: Replace customer exception {id} with customer {customerId} on wish list {wishListId}.
        slots:
          id: path.id
          customerId: requestBody.customerId
          wishListId: requestBody.wishListId
      - text: Overwrite the full wish list customer exception {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListCustomerExceptions({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a wish list customer exception
      effect: destructive
      questions:
      - How do I let an excluded customer see a wish list again?
      - Can I delete a customer exception only if its ETag matches?
      instructions:
      - text: Delete wish list customer exception {id}.
        slots:
          id: path.id
      - text: Remove customer exception {id} if the ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListCustomerExceptions({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a wish list customer exception
      effect: write
      questions:
      - How can I switch which customer an exception applies to?
      - Can I point an existing customer exception at another wish list?
      instructions:
      - text: Change the customer on exception {id} to {customerId}.
        slots:
          id: path.id
          customerId: requestBody.customerId
      - text: Move customer exception {id} to wish list {wishListId}.
        slots:
          id: path.id
          wishListId: requestBody.wishListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListCustomerExceptions/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get defaults for a new customer exception
      effect: read
      questions:
      - What default values does a new wish list customer exception have?
      - Where do I get a blank customer exception template?
      instructions:
      - text: Fetch the default wish list customer exception template.
      - text: Show starting values for a new customer exception.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/wishlistcustomerexceptions/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete wish list customer exceptions
      effect: destructive
      questions:
      - How do I clear several wish list customer exceptions at once?
      - Can I pass a list of ids to remove customer exceptions?
      instructions:
      - text: Bulk delete wish list customer exceptions {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every customer exception in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/wishlistcustomerexceptions({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of a customer exception
      effect: read
      questions:
      - Where can I read a custom property on a wish list customer exception?
      - How do I fetch one custom attribute from a customer exception?
      instructions:
      - text: Get custom property {custompropertyKey} of customer exception {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Read custom field {custompropertyKey} on wish list customer exception {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'