Optimizely · OpenAPI Overlay 1.0.0

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

10 actions 10 updates phrasing extends openapi/optimizely-user-profile-wish-list-tags-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/UserProfileWishListTags'].get
$.paths['/api/v1/admin/UserProfileWishListTags'].post
$.paths['/api/v1/admin/UserProfileWishListTags({id})'].get
$.paths['/api/v1/admin/UserProfileWishListTags({id})'].put
$.paths['/api/v1/admin/UserProfileWishListTags({id})'].delete
$.paths['/api/v1/admin/UserProfileWishListTags({id})'].patch
$.paths['/api/v1/admin/UserProfileWishListTags/Default.Default()'].get
$.paths['/api/v1/admin/userprofilewishlisttags/delete'].delete
$.paths['/api/v1/admin/userprofilewishlisttags({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 Tags API
  version: 1.0.0
extends: openapi/optimizely-user-profile-wish-list-tags-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/UserProfileWishListTags'].get
  update:
    x-apievangelist-phrasing:
      intent: List wish list tags
      effect: read
      questions:
      - What tags have shoppers put on their wish lists?
      - Can I filter wish list tags to one user profile or one wish list?
      - How many wish list tags are stored in total?
      instructions:
      - text: List all wish list tags.
      - text: List wish list tags where {filter}.
        slots:
          filter: query.$filter
      - text: Show wish list tags grouped with {apply}.
        slots:
          apply: query.$apply
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWishListTags'].post
  update:
    x-apievangelist-phrasing:
      intent: Tag a user's wish list
      effect: write
      questions:
      - How do I add a tag to a customer's wish list?
      - Can a wish list tag be tied to a specific user profile?
      instructions:
      - text: Tag wish list {wishListId} with {tag}.
        slots:
          wishListId: requestBody.wishListId
          tag: requestBody.tag
      - text: Add tag {tag} to wish list {wishListId} for user profile {userProfileId}.
        slots:
          tag: requestBody.tag
          wishListId: requestBody.wishListId
          userProfileId: requestBody.userProfileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWishListTags({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a wish list tag by id
      effect: read
      questions:
      - What tag text and wish list does a given tag record hold?
      - Can I fetch one wish list tag by its id?
      instructions:
      - text: Get wish list tag {id}.
        slots:
          id: path.id
      - text: Show which wish list tag record {id} belongs to.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWishListTags({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a wish list tag
      effect: write
      questions:
      - Can I fully rewrite a wish list tag record?
      - Does a full replace of a wish list tag clear fields I omit?
      instructions:
      - text: Replace wish list tag {id} with tag {tag} on wish list {wishListId}.
        slots:
          id: path.id
          tag: requestBody.tag
          wishListId: requestBody.wishListId
      - text: Overwrite the complete wish list tag record {id} with tag text {tag}.
        slots:
          id: path.id
          tag: requestBody.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWishListTags({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a wish list tag
      effect: destructive
      questions:
      - How do I remove a tag from someone's wish list?
      - Can I guard a wish list tag delete with an ETag?
      instructions:
      - text: Delete wish list tag {id}.
        slots:
          id: path.id
      - text: Delete wish list tag {id} if its ETag matches {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWishListTags({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a wish list tag
      effect: write
      questions:
      - Can I rename an existing wish list tag without recreating it?
      - Is a partial update supported for wish list tags?
      instructions:
      - text: Rename wish list tag {id} to {tag}.
        slots:
          id: path.id
          tag: requestBody.tag
      - text: Patch tag {id} to read {tag} and move it to wish list {wishListId}.
        slots:
          id: path.id
          tag: requestBody.tag
          wishListId: requestBody.wishListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWishListTags/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Call the wish list tags Default function
      effect: read
      questions:
      - What does the Default function on wish list tags return?
      - Is there a default wish list tag entry?
      instructions:
      - text: Call the Default function on wish list tags.
      - text: Fetch the default wish list tag result.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/userprofilewishlisttags/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete wish list tags
      effect: destructive
      questions:
      - Can I clear several wish list tags in one call?
      - Is there a bulk delete by id list for wish list tags?
      instructions:
      - text: Delete wish list tags {ids}.
        slots:
          ids: query.ids
      - text: Bulk remove the wish list tags with ids {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/userprofilewishlisttags({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of a wish list tag
      effect: read
      questions:
      - Can I read a custom property stored on a wish list tag?
      - Where is a custom value for a wish list tag kept?
      instructions:
      - text: Get custom property {custompropertyKey} of wish list tag {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show custom value {custompropertyKey} on wish list tag {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'