Optimizely · OpenAPI Overlay 1.0.0

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

10 actions 10 updates phrasing extends openapi/optimizely-wish-list-customer-additions-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/WishListCustomerAdditions'].get
$.paths['/api/v1/admin/WishListCustomerAdditions'].post
$.paths['/api/v1/admin/WishListCustomerAdditions({id})'].get
$.paths['/api/v1/admin/WishListCustomerAdditions({id})'].put
$.paths['/api/v1/admin/WishListCustomerAdditions({id})'].delete
$.paths['/api/v1/admin/WishListCustomerAdditions({id})'].patch
$.paths['/api/v1/admin/WishListCustomerAdditions/Default.Default()'].get
$.paths['/api/v1/admin/wishlistcustomeradditions/delete'].delete
$.paths['/api/v1/admin/wishlistcustomeradditions({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 Additions API
  version: 1.0.0
extends: openapi/optimizely-wish-list-customer-additions-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/WishListCustomerAdditions'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers added to wish lists
      effect: read
      questions:
      - Which customers have been added to shared wish lists?
      - Can I filter wish list customer additions by wish list?
      instructions:
      - text: List all wish list customer additions.
      - text: Find wish list customer additions matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListCustomerAdditions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a customer to a wish list
      effect: write
      questions:
      - How do I give another customer access to a wish list?
      - Can I link a customer account to an existing wish list?
      instructions:
      - text: Add 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/WishListCustomerAdditions({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a wish list customer addition by ID
      effect: read
      questions:
      - Which customer and wish list does one addition record link?
      - Can I look up a single wish list customer addition by its ID?
      instructions:
      - text: Get wish list customer addition {id}.
        slots:
          id: path.id
      - text: Show the customer and wish list linked by addition {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListCustomerAdditions({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a wish list customer addition
      effect: write
      questions:
      - Can I overwrite a whole wish list customer addition record at once?
      - What does a full replace of a wish list customer addition expect?
      instructions:
      - text: Replace wish list customer addition {id} with customer {customerId} on wish list {wishListId}.
        slots:
          id: path.id
          customerId: requestBody.customerId
          wishListId: requestBody.wishListId
      - text: Overwrite the entire wish list customer addition {id} using a full PUT.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListCustomerAdditions({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a customer from a wish list
      effect: destructive
      questions:
      - How do I revoke a customer's access to a shared wish list?
      - Does deleting a wish list customer addition accept an If-Match ETag?
      instructions:
      - text: Delete wish list customer addition {id}.
        slots:
          id: path.id
      - text: Delete wish list customer addition {id} only if its ETag matches {ifMatch}.
        slots:
          id: path.id
          ifMatch: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListCustomerAdditions({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a wish list customer addition
      effect: write
      questions:
      - How do I move a customer addition to a different wish list?
      - Can I change which customer an existing wish list addition points to?
      instructions:
      - text: Move wish list customer addition {id} to wish list {wishListId}.
        slots:
          id: path.id
          wishListId: requestBody.wishListId
      - text: Point wish list customer addition {id} at customer {customerId}.
        slots:
          id: path.id
          customerId: requestBody.customerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListCustomerAdditions/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a default wish list customer addition template
      effect: read
      questions:
      - What default values does a new wish list customer addition start with?
      - Is there a blank wish list customer addition template to fetch first?
      instructions:
      - text: Fetch the default wish list customer addition template.
      - text: Show me the default values for a new wish list customer addition.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/wishlistcustomeradditions/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete wish list customer additions
      effect: destructive
      questions:
      - How do I delete several wish list customer additions at once?
      - Can I pass a list of IDs to remove many wish list customer additions?
      instructions:
      - text: Bulk delete the wish list customer additions with IDs {ids}.
        slots:
          ids: query.ids
      - text: 'Remove all of these wish list customer additions in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/wishlistcustomeradditions({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a wish list addition
      effect: read
      questions:
      - Where do I read a custom property stored on a wish list customer addition?
      - Can I fetch one extra property value from a wish list customer addition?
      instructions:
      - text: Get custom property {custompropertyKey} on wish list customer addition {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show the custom property {custompropertyKey} of wish list addition {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'