Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 User Profile Wish List Favorites API

10 actions 10 updates phrasing extends openapi/optimizely-user-profile-wish-list-favorites-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/UserProfileWishListFavorites'].get
$.paths['/api/v1/admin/UserProfileWishListFavorites'].post
$.paths['/api/v1/admin/UserProfileWishListFavorites({id})'].get
$.paths['/api/v1/admin/UserProfileWishListFavorites({id})'].put
$.paths['/api/v1/admin/UserProfileWishListFavorites({id})'].delete
$.paths['/api/v1/admin/UserProfileWishListFavorites({id})'].patch
$.paths['/api/v1/admin/UserProfileWishListFavorites/Default.Default()'].get
$.paths['/api/v1/admin/userprofilewishlistfavorites/delete'].delete
$.paths['/api/v1/admin/userprofilewishlistfavorites({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 User Profile Wish List Favorites API
  version: 1.0.0
extends: openapi/optimizely-user-profile-wish-list-favorites-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/UserProfileWishListFavorites'].get
  update:
    x-apievangelist-phrasing:
      intent: List users' favorite wish lists
      effect: read
      questions:
      - Which wish lists have shoppers marked as favorites?
      - Can I filter favorite wish lists down to one user profile?
      - How many wish list favorites are recorded across all users?
      instructions:
      - text: List all user profile wish list favorites.
      - text: List wish list favorites matching {filter}.
        slots:
          filter: query.$filter
      - text: Show the first {top} wish list favorites ordered by {orderby}.
        slots:
          top: query.$top
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWishListFavorites'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a wish list as a user's favorite
      effect: write
      questions:
      - How do I mark a wish list as a favorite for a particular user?
      - Can I create a favorite link between a user profile and a wish list?
      instructions:
      - text: Favorite wish list {wishListId} for user profile {userProfileId}.
        slots:
          wishListId: requestBody.wishListId
          userProfileId: requestBody.userProfileId
      - text: Create a new wish list favorite record for user {userProfileId}.
        slots:
          userProfileId: requestBody.userProfileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWishListFavorites({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one wish list favorite
      effect: read
      questions:
      - Which user and wish list does a specific favorite record connect?
      - Can I fetch a single wish list favorite by its ID?
      instructions:
      - text: Get wish list favorite {id}.
        slots:
          id: path.id
      - text: Show wish list favorite {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWishListFavorites({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a wish list favorite record
      effect: write
      questions:
      - Is there a way to overwrite a whole wish list favorite record at once?
      - What call fully replaces an existing user-to-wish-list favorite?
      instructions:
      - text: Replace wish list favorite {id} with user {userProfileId} and wish list {wishListId}.
        slots:
          id: path.id
          userProfileId: requestBody.userProfileId
          wishListId: requestBody.wishListId
      - text: Overwrite the full wish list favorite record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWishListFavorites({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unfavorite a wish list
      effect: destructive
      questions:
      - How do I remove a wish list from a user's favorites?
      - Can I delete one wish list favorite by ID?
      instructions:
      - text: Delete wish list favorite {id}.
        slots:
          id: path.id
      - text: Remove wish list favorite {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/UserProfileWishListFavorites({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a wish list favorite
      effect: write
      questions:
      - Can I point an existing favorite at a different wish list?
      - How do I reassign a wish list favorite to another user profile?
      instructions:
      - text: Point wish list favorite {id} at wish list {wishListId}.
        slots:
          id: path.id
          wishListId: requestBody.wishListId
      - text: Reassign wish list favorite {id} to user profile {userProfileId}.
        slots:
          id: path.id
          userProfileId: requestBody.userProfileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWishListFavorites/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Call the Default function on wish list favorites
      effect: read
      questions:
      - What does the Default function on user profile wish list favorites return?
      - Is there a Default operation for wish list favorites?
      instructions:
      - text: Call the Default function on user profile wish list favorites.
      - text: Run the wish list favorites Default operation and show the result.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/userprofilewishlistfavorites/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete wish list favorites by ID
      effect: destructive
      questions:
      - Can I remove many wish list favorites in one call?
      - How do I clear a batch of wish list favorites by their IDs?
      instructions:
      - text: Delete the wish list favorites with IDs {ids}.
        slots:
          ids: query.ids
      - text: Bulk remove wish list favorites {ids} together.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/userprofilewishlistfavorites({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of a wish list favorite
      effect: read
      questions:
      - How can I read a custom property stored on a wish list favorite?
      - Do wish list favorites carry custom properties I can fetch by key?
      instructions:
      - text: Get custom property {custompropertyKey} of wish list favorite {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show the value of custom property {custompropertyKey} on wish list favorite {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'