# 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 Admin User Profile Preferences API
  version: 1.0.0
extends: openapi/optimizely-admin-user-profile-preferences-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: 14
- target: $.paths['/api/v1/admin/AdminUserProfilePreferences'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin user profile preferences
      effect: read
      questions:
      - Which saved preferences exist across all admin user profiles?
      - Can I filter admin preferences by name and page through them with $top and $skip?
      instructions:
      - text: List all admin user profile preferences.
      - text: Find admin user profile preferences matching the filter {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfilePreferences'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a preference for an admin user profile
      effect: write
      questions:
      - How do I save a named preference for a specific admin user profile?
      - What fields are required when adding an admin preference for any profile?
      instructions:
      - text: Create preference {name} with value {value} for admin profile {adminUserProfileId}.
        slots:
          name: requestBody.name
          value: requestBody.value
          adminUserProfileId: requestBody.adminUserProfileId
      - text: Add an admin user profile preference named {name} set to {value} for profile {adminUserProfileId}.
        slots:
          name: requestBody.name
          value: requestBody.value
          adminUserProfileId: requestBody.adminUserProfileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfilePreferences({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an admin user profile preference by ID
      effect: read
      questions:
      - What value is stored in one admin preference record by its ID?
      - Can I fetch a single admin user profile preference by its key?
      instructions:
      - text: Get admin user profile preference {id}.
        slots:
          id: path.id
      - text: Show the name and value of admin preference record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfilePreferences({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an admin user profile preference
      effect: write
      questions:
      - How do I overwrite an entire admin preference record by ID?
      - Does replacing an admin preference require sending both name and value again?
      instructions:
      - text: Replace admin preference {id} with name {name} and value {value}.
        slots:
          id: path.id
          name: requestBody.name
          value: requestBody.value
      - text: Overwrite the whole admin user profile preference {id} using a full PUT.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfilePreferences({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an admin user profile preference by ID
      effect: destructive
      questions:
      - Can I delete one admin preference record by its ID?
      - Does deleting an admin preference support an If-Match ETag check?
      instructions:
      - text: Delete admin user profile preference {id}.
        slots:
          id: path.id
      - text: Delete admin preference record {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/AdminUserProfilePreferences({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an admin user profile preference by ID
      effect: write
      questions:
      - How do I change the value of one admin preference record by ID?
      - Can I partially update an admin user profile preference?
      instructions:
      - text: Update admin preference record {id} to value {value}.
        slots:
          id: path.id
          value: requestBody.value
      - text: Patch admin user profile preference {id}, setting {name} to {value}.
        slots:
          id: path.id
          name: requestBody.name
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfilePreferences/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a default admin preference template
      effect: read
      questions:
      - What default values does a new admin user profile preference start with?
      - Is there a blank admin preference template I can fetch before creating one?
      instructions:
      - text: Fetch the default admin user profile preference template.
      - text: Show me the default values for a new admin preference.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfilePreferences/Default.Current()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my admin preferences via the Current() function
      effect: read
      questions:
      - How do I read the signed-in admin's preferences through the OData Current() function?
      - Can the Default.Current() function return only selected preference fields?
      instructions:
      - text: Call the OData Default.Current() function to get my admin preferences.
      - text: Get my admin preferences through Current() selecting only {select}.
        slots:
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminuserprofilepreferences/Current'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my admin preferences via the /Current route
      effect: read
      questions:
      - What preferences are saved for me, using the plain /Current route?
      - Can I read the logged-in admin's preferences without the OData function syntax?
      instructions:
      - text: Read my own admin preferences from the /Current route.
      - text: Fetch the current admin's preferences from the /Current route, expanding {expand}.
        slots:
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminuserprofilepreferences/Current'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a preference for the signed-in admin
      effect: write
      questions:
      - How do I save a new preference for myself as the logged-in admin?
      - Can I store a named setting on my own admin profile without knowing my profile ID?
      instructions:
      - text: Save my admin preference {name} with value {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
      - text: Add a new preference {name} = {value} to my own admin profile.
        slots:
          name: requestBody.name
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminuserprofilepreferences/Current'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one of my own admin preferences by name
      effect: destructive
      questions:
      - Can I delete one of my own admin preferences by its name?
      - What happens to my admin setting when I remove it from the current profile?
      instructions:
      - text: Remove my admin preference named {name}.
        slots:
          name: query.name
      - text: Delete the {name} setting from my own admin profile.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminuserprofilepreferences/Current'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change one of my own admin preferences
      effect: write
      questions:
      - How do I change the value of a preference on my own admin profile?
      - Can I update my current admin setting by name rather than by record ID?
      instructions:
      - text: Change my admin preference {name} to {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
      - text: Update my own {name} setting to {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminuserprofilepreferences/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete admin user profile preferences
      effect: destructive
      questions:
      - How do I delete several admin preference records at once?
      - Can I pass a list of IDs to remove many admin user profile preferences?
      instructions:
      - text: Bulk delete the admin user profile preferences with IDs {ids}.
        slots:
          ids: query.ids
      - text: 'Remove all of these admin preference records in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminuserprofilepreferences({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on an admin preference
      effect: read
      questions:
      - Where do I read a custom property stored on an admin user profile preference?
      - Can I fetch one extra property value from an admin preference record?
      instructions:
      - text: Get custom property {custompropertyKey} on admin preference {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show the custom property {custompropertyKey} of admin user profile preference {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'