Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Admin User Profile Websites API

10 actions 10 updates phrasing extends openapi/optimizely-admin-user-profile-websites-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/AdminUserProfileWebsites'].get
$.paths['/api/v1/admin/AdminUserProfileWebsites'].post
$.paths['/api/v1/admin/AdminUserProfileWebsites({id})'].get
$.paths['/api/v1/admin/AdminUserProfileWebsites({id})'].put
$.paths['/api/v1/admin/AdminUserProfileWebsites({id})'].delete
$.paths['/api/v1/admin/AdminUserProfileWebsites({id})'].patch
$.paths['/api/v1/admin/AdminUserProfileWebsites/Default.Default()'].get
$.paths['/api/v1/admin/adminuserprofilewebsites/delete'].delete
$.paths['/api/v1/admin/adminuserprofilewebsites({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 Admin User Profile Websites API
  version: 1.0.0
extends: openapi/optimizely-admin-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/AdminUserProfileWebsites'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin user website assignments
      effect: read
      questions:
      - Which websites is each admin user allowed to manage?
      - Can I filter admin website assignments down to one admin user profile?
      - How many admin-to-website assignments exist?
      instructions:
      - text: List all admin user website assignments.
      - text: List admin user website assignments where {filter}.
        slots:
          filter: query.$filter
      - text: Show admin website assignments ordered by {orderby}.
        slots:
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfileWebsites'].post
  update:
    x-apievangelist-phrasing:
      intent: Give an admin user access to a website
      effect: write
      questions:
      - How do I grant an admin user access to another storefront website?
      - Can I link an admin user profile to a website through the admin API?
      instructions:
      - text: Assign admin user profile {adminUserProfileId} to website {websiteId}.
        slots:
          adminUserProfileId: requestBody.adminUserProfileId
          websiteId: requestBody.websiteId
      - text: Grant admin {adminUserProfileId} access to manage website {websiteId}.
        slots:
          adminUserProfileId: requestBody.adminUserProfileId
          websiteId: requestBody.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfileWebsites({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an admin user website assignment
      effect: read
      questions:
      - Can I look up one admin-to-website assignment by its id?
      - Who created a particular admin website assignment and when?
      instructions:
      - text: Get admin user website assignment {id}.
        slots:
          id: path.id
      - text: Show who created admin website assignment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfileWebsites({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an admin user website assignment
      effect: write
      questions:
      - Can I fully rewrite an existing admin website assignment?
      - Does replacing an admin website assignment reset its other fields?
      instructions:
      - text: Replace admin website assignment {id} so it links admin {adminUserProfileId} to website {websiteId}.
        slots:
          id: path.id
          adminUserProfileId: requestBody.adminUserProfileId
          websiteId: requestBody.websiteId
      - text: Overwrite the whole admin website assignment record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfileWebsites({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an admin user's access to a website
      effect: destructive
      questions:
      - How do I revoke an admin user's access to a single website?
      - Can the delete be made conditional on an ETag?
      instructions:
      - text: Delete admin website assignment {id}.
        slots:
          id: path.id
      - text: Revoke admin website assignment {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/AdminUserProfileWebsites({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an admin user website assignment
      effect: write
      questions:
      - Can I point an existing admin assignment at a different website?
      - Is a partial update supported for admin website assignments?
      instructions:
      - text: Move admin website assignment {id} to website {websiteId}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
      - text: Patch assignment {id} to belong to admin profile {adminUserProfileId}.
        slots:
          id: path.id
          adminUserProfileId: requestBody.adminUserProfileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfileWebsites/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Call the admin user websites Default function
      effect: read
      questions:
      - What does the Default function return for admin user profile websites?
      - Is there a default admin website assignment entry?
      instructions:
      - text: Call the Default function on admin user profile websites.
      - text: Fetch the default admin website assignment result.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminuserprofilewebsites/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete admin user website assignments
      effect: destructive
      questions:
      - Can I remove many admin website assignments in a single call?
      - Is there a bulk delete for admin user website links by id list?
      instructions:
      - text: Delete admin website assignments {ids}.
        slots:
          ids: query.ids
      - text: Bulk revoke the admin website links with ids {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminuserprofilewebsites({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of an admin website assignment
      effect: read
      questions:
      - Can I read a custom property stored on an admin website assignment?
      - Where is a custom property value for an admin-to-website link kept?
      instructions:
      - text: Get custom property {custompropertyKey} of admin website assignment {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show custom value {custompropertyKey} on admin website link {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'