Optimizely · OpenAPI Overlay 1.0.0

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

10 actions 10 updates phrasing extends openapi/optimizely-user-profile-wish-list-hides-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/UserProfileWishListHides'].get
$.paths['/api/v1/admin/UserProfileWishListHides'].post
$.paths['/api/v1/admin/UserProfileWishListHides({id})'].get
$.paths['/api/v1/admin/UserProfileWishListHides({id})'].put
$.paths['/api/v1/admin/UserProfileWishListHides({id})'].delete
$.paths['/api/v1/admin/UserProfileWishListHides({id})'].patch
$.paths['/api/v1/admin/UserProfileWishListHides/Default.Default()'].get
$.paths['/api/v1/admin/userprofilewishlisthides/delete'].delete
$.paths['/api/v1/admin/userprofilewishlisthides({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 Hides API
  version: 1.0.0
extends: openapi/optimizely-user-profile-wish-list-hides-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/UserProfileWishListHides'].get
  update:
    x-apievangelist-phrasing:
      intent: List wish lists hidden by users
      effect: read
      questions:
      - How do I see which shared wish lists users have hidden?
      - Can I filter hidden wish list records to one user profile?
      instructions:
      - text: List all user wish list hides.
      - text: List wish list hides matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWishListHides'].post
  update:
    x-apievangelist-phrasing:
      intent: Hide a wish list for a user
      effect: write
      questions:
      - How do I hide a wish list from a particular user's view?
      - Can I record that a user dismissed a shared wish list?
      instructions:
      - text: Hide wish list {wishListId} for user profile {userProfileId}.
        slots:
          wishListId: requestBody.wishListId
          userProfileId: requestBody.userProfileId
      - text: Record that user {userProfileId} hid wish list {wishListId}.
        slots:
          userProfileId: requestBody.userProfileId
          wishListId: requestBody.wishListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWishListHides({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one wish list hide record
      effect: read
      questions:
      - How do I look up a single wish list hide by its id?
      - Which user and wish list does a given hide record link?
      instructions:
      - text: Get wish list hide {id}.
        slots:
          id: path.id
      - text: Show the user and wish list on hide record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWishListHides({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a wish list hide record
      effect: write
      questions:
      - How do I overwrite a wish list hide record entirely?
      - Is there a full replace for a user's hidden wish list entry?
      instructions:
      - text: Replace hide record {id} with user {userProfileId} and wish list {wishListId}.
        slots:
          id: path.id
          userProfileId: requestBody.userProfileId
          wishListId: requestBody.wishListId
      - text: Overwrite the whole wish list hide record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWishListHides({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unhide a wish list for a user
      effect: destructive
      questions:
      - How do I make a hidden wish list visible to a user again?
      - Can I delete a wish list hide only if the ETag matches?
      instructions:
      - text: Delete wish list hide {id}.
        slots:
          id: path.id
      - text: Delete wish list hide {id} if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWishListHides({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a wish list hide record
      effect: write
      questions:
      - How do I change which wish list a hide record points to?
      - Can I update just the user on a wish list hide?
      instructions:
      - text: Change hide record {id} to wish list {wishListId}.
        slots:
          id: path.id
          wishListId: requestBody.wishListId
      - text: Patch hide record {id} to user profile {userProfileId}.
        slots:
          id: path.id
          userProfileId: requestBody.userProfileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWishListHides/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default wish list hide record
      effect: read
      questions:
      - What does a default wish list hide record look like?
      - Can I get the template values for a new wish list hide?
      instructions:
      - text: Get the default wish list hide record.
      - text: Show the template for a new wish list hide.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/userprofilewishlisthides/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete wish list hides
      effect: destructive
      questions:
      - How do I remove many wish list hide records at once?
      - Can I bulk unhide wish lists by a list of ids?
      instructions:
      - text: Bulk delete wish list hides {ids}.
        slots:
          ids: query.ids
      - text: 'Unhide these wish list records in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/userprofilewishlisthides({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a wish list hide
      effect: read
      questions:
      - How do I read a custom property on a wish list hide record?
      - Can I fetch one extension property of a hidden wish list entry?
      instructions:
      - text: Get custom property {custompropertyKey} on wish list hide {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show custom property {custompropertyKey} for wish list hide record {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'