Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Restriction Group Customer Exceptions API

10 actions 10 updates phrasing extends openapi/optimizely-restriction-group-customer-exceptions-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/RestrictionGroupCustomerExceptions'].get
$.paths['/api/v1/admin/RestrictionGroupCustomerExceptions'].post
$.paths['/api/v1/admin/RestrictionGroupCustomerExceptions({id})'].get
$.paths['/api/v1/admin/RestrictionGroupCustomerExceptions({id})'].put
$.paths['/api/v1/admin/RestrictionGroupCustomerExceptions({id})'].delete
$.paths['/api/v1/admin/RestrictionGroupCustomerExceptions({id})'].patch
$.paths['/api/v1/admin/RestrictionGroupCustomerExceptions/Default.Default()'].get
$.paths['/api/v1/admin/restrictiongroupcustomerexceptions/delete'].delete
$.paths['/api/v1/admin/restrictiongroupcustomerexceptions({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 Restriction Group Customer Exceptions API
  version: 1.0.0
extends: openapi/optimizely-restriction-group-customer-exceptions-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/RestrictionGroupCustomerExceptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer exceptions to restriction groups
      effect: read
      questions:
      - Which customers are exempted from product restriction groups in Optimizely Configured Commerce?
      - Can I filter restriction group exceptions to a single customer?
      instructions:
      - text: List all restriction group customer exceptions.
      - text: List restriction group customer exceptions matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupCustomerExceptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Exempt a customer from a restriction group
      effect: write
      questions:
      - How do I let one customer see products that a restriction group normally hides?
      - Can I add an exception for a customer to a specific restriction group?
      instructions:
      - text: Exempt customer {customerId} from restriction group {restrictionGroupId}.
        slots:
          customerId: requestBody.customerId
          restrictionGroupId: requestBody.restrictionGroupId
      - text: Create a restriction group exception for customer {customerId}.
        slots:
          customerId: requestBody.customerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupCustomerExceptions({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one restriction group exception
      effect: read
      questions:
      - How can I look up a single customer exception record by ID?
      - Can I expand the customer or restriction group on one exception?
      instructions:
      - text: Show restriction group customer exception {id}.
        slots:
          id: path.id
      - text: Get restriction group exception {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupCustomerExceptions({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a restriction group exception
      effect: write
      questions:
      - Can I overwrite an exception record with a different customer and group?
      - What's the call to fully replace a restriction group exception?
      instructions:
      - text: Replace exception {id} to link customer {customerId} with restriction group {restrictionGroupId}.
        slots:
          id: path.id
          customerId: requestBody.customerId
          restrictionGroupId: requestBody.restrictionGroupId
      - text: Overwrite restriction group exception {id} entirely for customer {customerId}.
        slots:
          id: path.id
          customerId: requestBody.customerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupCustomerExceptions({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a customer's restriction exception
      effect: destructive
      questions:
      - How do I take away a customer's exemption from a restriction group?
      - Can I delete an exception only if its ETag still matches?
      instructions:
      - text: Delete restriction group customer exception {id}.
        slots:
          id: path.id
      - text: Delete exception {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/RestrictionGroupCustomerExceptions({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a restriction group exception
      effect: write
      questions:
      - Can I move an existing exception to a different restriction group?
      - How do I change only the customer on an exception record?
      instructions:
      - text: Patch exception {id} to restriction group {restrictionGroupId}.
        slots:
          id: path.id
          restrictionGroupId: requestBody.restrictionGroupId
      - text: Update exception {id} so it applies to customer {customerId}.
        slots:
          id: path.id
          customerId: requestBody.customerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupCustomerExceptions/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for an exception
      effect: read
      questions:
      - What defaults are pre-filled for a new restriction group customer exception?
      - Is there a blank exception template?
      instructions:
      - text: Get the default restriction group customer exception template.
      - text: Show pre-filled values for a new customer exception.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/restrictiongroupcustomerexceptions/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several restriction group exceptions
      effect: destructive
      questions:
      - Can I bulk remove customer exceptions from restriction groups?
      - How do I delete many exception records in one call?
      instructions:
      - text: Bulk delete restriction group customer exceptions {ids}.
        slots:
          ids: query.ids
      - text: Remove every exception listed in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/restrictiongroupcustomerexceptions({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on an exception
      effect: read
      questions:
      - Can I read a custom property on a restriction group exception?
      - Where are custom attributes on an exception record stored?
      instructions:
      - text: Get custom property {custompropertyKey} on restriction group exception {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show exception {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'