# 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 Websites API
  version: 1.0.0
extends: openapi/optimizely-user-profile-websites-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/UserProfileWebsites'].get
  update:
    x-apievangelist-phrasing:
      intent: List user-to-website assignments
      effect: read
      questions:
      - Which users have access to which of my commerce websites?
      - Can I filter user website assignments by user profile or website?
      instructions:
      - text: List all user profile website assignments.
      - text: List user website assignments matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWebsites'].post
  update:
    x-apievangelist-phrasing:
      intent: Give a user access to a website
      effect: write
      questions:
      - How do I grant a user profile access to another website?
      - What do I need to link a user to a website - just the two IDs?
      instructions:
      - text: Assign user profile {userProfileId} to website {websiteId}.
        slots:
          userProfileId: requestBody.userProfileId
          websiteId: requestBody.websiteId
      - text: Give user {userProfileId} access to site {websiteId}.
        slots:
          userProfileId: requestBody.userProfileId
          websiteId: requestBody.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWebsites({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one user-to-website assignment
      effect: read
      questions:
      - How do I read a single user profile website link by ID?
      - Can I expand the user or website on one assignment?
      instructions:
      - text: Get user profile website {id}.
        slots:
          id: path.id
      - text: Show user website assignment {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWebsites({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a user-to-website assignment
      effect: write
      questions:
      - How do I overwrite a user website assignment with a full new record?
      - Does replacing an assignment require both the user and website IDs?
      instructions:
      - text: Replace assignment {id} with user {userProfileId} on website {websiteId}.
        slots:
          id: path.id
          userProfileId: requestBody.userProfileId
          websiteId: requestBody.websiteId
      - text: Fully overwrite user profile website record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWebsites({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user's access to a website
      effect: destructive
      questions:
      - How do I revoke a user's access to one website?
      - Can I delete a user website assignment only if its ETag matches?
      instructions:
      - text: Delete user profile website {id}.
        slots:
          id: path.id
      - text: Remove website assignment {id} if ETag {ifMatch} matches.
        slots:
          id: path.id
          ifMatch: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWebsites({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Move a user assignment to another website
      effect: write
      questions:
      - Can I switch an existing assignment to a different website?
      - How do I reassign a website link to another user profile?
      instructions:
      - text: Point assignment {id} at website {websiteId}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
      - text: Reassign website link {id} to user {userProfileId}.
        slots:
          id: path.id
          userProfileId: requestBody.userProfileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileWebsites/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Call the Default function on user websites
      effect: read
      questions:
      - What does the Default OData function on user profile websites return?
      - Is there a default user profile website entity I can read?
      instructions:
      - text: Call the Default function on user profile websites.
      - text: Get the default user profile website entity.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/userprofilewebsites/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk remove user website assignments
      effect: destructive
      questions:
      - Can I revoke many user website assignments in one request?
      - How do I delete a list of user profile website links by ID?
      instructions:
      - text: Bulk delete user profile websites {ids}.
        slots:
          ids: query.ids
      - text: 'Revoke these website assignments at once: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/userprofilewebsites({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a user website link
      effect: read
      questions:
      - How do I read a custom property on a user profile website assignment?
      - Can user website assignments hold custom fields?
      instructions:
      - text: Get custom property {custompropertyKey} of user website assignment {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Read custom field {custompropertyKey} on user profile website {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'