Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Wish List Customers API

10 actions 10 updates phrasing extends openapi/optimizely-wish-list-customers-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/WishListCustomers'].get
$.paths['/api/v1/admin/WishListCustomers'].post
$.paths['/api/v1/admin/WishListCustomers({id})'].get
$.paths['/api/v1/admin/WishListCustomers({id})'].put
$.paths['/api/v1/admin/WishListCustomers({id})'].delete
$.paths['/api/v1/admin/WishListCustomers({id})'].patch
$.paths['/api/v1/admin/WishListCustomers/Default.Default()'].get
$.paths['/api/v1/admin/wishlistcustomers/delete'].delete
$.paths['/api/v1/admin/wishlistcustomers({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 Customers API
  version: 1.0.0
extends: openapi/optimizely-wish-list-customers-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/WishListCustomers'].get
  update:
    x-apievangelist-phrasing:
      intent: List wish list sharing with customers
      effect: read
      questions:
      - Which customers have access to which wish lists in my commerce store?
      - Can I filter to see every customer linked to one wish list?
      - How many wish list to customer links are there?
      instructions:
      - text: List all wish list customer links.
      - text: Find wish list customer links matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListCustomers'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a customer to a wish list
      effect: write
      questions:
      - How do I give a customer account access to a wish list?
      - Can I associate a wish list with another customer?
      instructions:
      - text: Link customer {customerId} to wish list {wishListId}.
        slots:
          customerId: requestBody.customerId
          wishListId: requestBody.wishListId
      - text: Share wish list {wishListId} with customer {customerId}.
        slots:
          wishListId: requestBody.wishListId
          customerId: requestBody.customerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListCustomers({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one wish list customer link
      effect: read
      questions:
      - Which wish list and customer does a specific link record connect?
      - How do I look up a single wish list customer record by ID?
      instructions:
      - text: Get wish list customer link {id}.
        slots:
          id: path.id
      - text: Show wish list link {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListCustomers({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a wish list customer link
      effect: write
      questions:
      - How do I overwrite a wish list customer link entirely?
      - Can I fully replace both the wish list and customer on a link record?
      instructions:
      - text: Replace link {id} so wish list {wishListId} belongs to customer {customerId}.
        slots:
          id: path.id
          wishListId: requestBody.wishListId
          customerId: requestBody.customerId
      - text: Overwrite the full wish list customer record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListCustomers({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink a customer from a wish list
      effect: destructive
      questions:
      - How do I remove a customer's access to a wish list?
      - Can I delete a wish list customer link only if its ETag matches?
      instructions:
      - text: Delete wish list customer link {id}.
        slots:
          id: path.id
      - text: Delete link {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/WishListCustomers({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Reassign a wish list customer link
      effect: write
      questions:
      - Can I switch an existing wish list link to a different customer?
      - How do I change only the wish list on a customer link?
      instructions:
      - text: Reassign link {id} to customer {customerId}.
        slots:
          id: path.id
          customerId: requestBody.customerId
      - text: Point link {id} at wish list {wishListId} instead.
        slots:
          id: path.id
          wishListId: requestBody.wishListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListCustomers/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default wish list customer template
      effect: read
      questions:
      - What default values does a new wish list customer link start with?
      - Is there a blank wish list customer template?
      instructions:
      - text: Fetch the default wish list customer template.
      - text: Get default values for a new wish list customer link.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/wishlistcustomers/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete wish list customer links
      effect: destructive
      questions:
      - How do I remove many wish list customer links at once?
      - Can I delete several wish list sharing records by ID?
      instructions:
      - text: Bulk delete wish list customer links {ids}.
        slots:
          ids: query.ids
      - text: 'Remove all these wish list links in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/wishlistcustomers({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of a wish list customer link
      effect: read
      questions:
      - How do I read a custom property on a wish list customer link?
      - Can I fetch one custom field from a wish list customer record?
      instructions:
      - text: Get custom property {custompropertyKey} of wish list link {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show custom field {custompropertyKey} on wish list customer record {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'