Optimizely · OpenAPI Overlay 1.0.0

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

10 actions 10 updates phrasing extends openapi/optimizely-restriction-group-customer-additions-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/RestrictionGroupCustomerAdditions'].get
$.paths['/api/v1/admin/RestrictionGroupCustomerAdditions'].post
$.paths['/api/v1/admin/RestrictionGroupCustomerAdditions({id})'].get
$.paths['/api/v1/admin/RestrictionGroupCustomerAdditions({id})'].put
$.paths['/api/v1/admin/RestrictionGroupCustomerAdditions({id})'].delete
$.paths['/api/v1/admin/RestrictionGroupCustomerAdditions({id})'].patch
$.paths['/api/v1/admin/RestrictionGroupCustomerAdditions/Default.Default()'].get
$.paths['/api/v1/admin/restrictiongroupcustomeradditions/delete'].delete
$.paths['/api/v1/admin/restrictiongroupcustomeradditions({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 Additions API
  version: 1.0.0
extends: openapi/optimizely-restriction-group-customer-additions-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/RestrictionGroupCustomerAdditions'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers added to restriction groups
      effect: read
      questions:
      - Which customers have been added to product restriction groups?
      - Can I filter restriction group additions to one customer?
      - How many customers are assigned to a restriction group?
      instructions:
      - text: List all restriction group customer additions.
      - text: Find restriction group additions matching {filter}.
        slots:
          filter: query.$filter
      - text: Count the restriction group additions matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupCustomerAdditions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a customer to a restriction group
      effect: write
      questions:
      - How do I put a customer into a product restriction group?
      - Can I assign one customer to several restriction groups?
      instructions:
      - text: Add customer {customerId} to restriction group {restrictionGroupId}.
        slots:
          customerId: requestBody.customerId
          restrictionGroupId: requestBody.restrictionGroupId
      - text: Assign restriction group {restrictionGroupId} to customer {customerId}.
        slots:
          restrictionGroupId: requestBody.restrictionGroupId
          customerId: requestBody.customerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupCustomerAdditions({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a restriction group customer addition
      effect: read
      questions:
      - How do I look up one customer-to-restriction-group assignment?
      - Which customer and group does a given addition record link?
      instructions:
      - text: Get restriction group addition {id}.
        slots:
          id: path.id
      - text: Show which customer and group addition {id} links.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupCustomerAdditions({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a restriction group customer addition
      effect: write
      questions:
      - How do I overwrite a restriction group assignment record in full?
      - Does replacing an addition reset fields I don't send?
      instructions:
      - text: Replace addition {id} so it links customer {customerId} to group {restrictionGroupId}.
        slots:
          id: path.id
          customerId: requestBody.customerId
          restrictionGroupId: requestBody.restrictionGroupId
      - text: Overwrite every field of restriction group addition {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupCustomerAdditions({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a customer from a restriction group
      effect: destructive
      questions:
      - How do I take a customer out of a restriction group?
      - Can I delete a restriction group addition only if its ETag matches?
      instructions:
      - text: Delete restriction group addition {id}.
        slots:
          id: path.id
      - text: Delete restriction group addition {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/RestrictionGroupCustomerAdditions({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a restriction group customer addition
      effect: write
      questions:
      - How do I move a customer's addition to a different restriction group?
      - Can I change the customer on an existing addition record?
      instructions:
      - text: Point addition {id} at restriction group {restrictionGroupId}.
        slots:
          id: path.id
          restrictionGroupId: requestBody.restrictionGroupId
      - text: Change the customer on addition {id} to {customerId}.
        slots:
          id: path.id
          customerId: requestBody.customerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupCustomerAdditions/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a default restriction group addition template
      effect: read
      questions:
      - What default values does a new restriction group addition start with?
      - Can I fetch a blank restriction group addition template?
      instructions:
      - text: Fetch the default restriction group addition template.
      - text: Show me the defaults for a new restriction group addition.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/restrictiongroupcustomeradditions/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk remove restriction group customer additions
      effect: destructive
      questions:
      - How do I remove many customers from restriction groups at once?
      - Can I delete restriction group additions by a list of IDs?
      instructions:
      - text: Bulk delete restriction group additions {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these restriction group additions in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/restrictiongroupcustomeradditions({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a restriction group addition
      effect: read
      questions:
      - How do I read a custom property stored on a restriction group addition?
      - Can I fetch one extra property from a restriction group addition?
      instructions:
      - text: Get custom property {custompropertyKey} on restriction group addition {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show restriction group addition {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'