Optimizely · OpenAPI Overlay 1.0.0

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

10 actions 10 updates phrasing extends openapi/optimizely-restriction-group-product-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/RestrictionGroupProductAdditions'].get
$.paths['/api/v1/admin/RestrictionGroupProductAdditions'].post
$.paths['/api/v1/admin/RestrictionGroupProductAdditions({id})'].get
$.paths['/api/v1/admin/RestrictionGroupProductAdditions({id})'].put
$.paths['/api/v1/admin/RestrictionGroupProductAdditions({id})'].delete
$.paths['/api/v1/admin/RestrictionGroupProductAdditions({id})'].patch
$.paths['/api/v1/admin/RestrictionGroupProductAdditions/Default.Default()'].get
$.paths['/api/v1/admin/restrictiongroupproductadditions/delete'].delete
$.paths['/api/v1/admin/restrictiongroupproductadditions({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 Product Additions API
  version: 1.0.0
extends: openapi/optimizely-restriction-group-product-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/RestrictionGroupProductAdditions'].get
  update:
    x-apievangelist-phrasing:
      intent: List products added to restriction groups
      effect: read
      questions:
      - Which products have been explicitly added to restriction groups in my commerce catalog?
      - Can I filter restriction group product additions to a single restriction group?
      - What does the full list of restriction group product additions contain?
      instructions:
      - text: List all restriction group product additions.
      - text: List restriction group product additions matching {filter}.
        slots:
          filter: query.$filter
      - text: Show {top} restriction group product additions, skipping the first {skip}.
        slots:
          top: query.$top
          skip: query.$skip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupProductAdditions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a product to a restriction group
      effect: write
      questions:
      - How do I add a product to a restriction group?
      - Can I link one product to a specific restriction group through the admin API?
      instructions:
      - text: Add product {productId} to restriction group {restrictionGroupId}.
        slots:
          productId: requestBody.productId
          restrictionGroupId: requestBody.restrictionGroupId
      - text: Create a restriction group product addition for product {productId}.
        slots:
          productId: requestBody.productId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupProductAdditions({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one restriction group product addition
      effect: read
      questions:
      - Which product and restriction group does a specific addition record link?
      - Can I fetch a single restriction group product addition by ID?
      instructions:
      - text: Get restriction group product addition {id}.
        slots:
          id: path.id
      - text: Show restriction group product addition {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupProductAdditions({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a restriction group product addition
      effect: write
      questions:
      - Is there a way to overwrite a whole restriction group product addition record?
      - What call fully replaces an existing product-to-restriction-group link?
      instructions:
      - text: Replace restriction group product addition {id} to link product {productId} with group {restrictionGroupId}.
        slots:
          id: path.id
          productId: requestBody.productId
          restrictionGroupId: requestBody.restrictionGroupId
      - text: Overwrite the full restriction group product addition {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupProductAdditions({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a product from a restriction group
      effect: destructive
      questions:
      - How do I take a product back out of a restriction group?
      - Can I delete one restriction group product addition by ID?
      instructions:
      - text: Delete restriction group product addition {id}.
        slots:
          id: path.id
      - text: Remove restriction group product addition {id} if its ETag is {ifMatch}.
        slots:
          id: path.id
          ifMatch: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupProductAdditions({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a restriction group product addition
      effect: write
      questions:
      - Can I move an existing product addition to a different restriction group?
      - How do I change which product an existing restriction group addition points at?
      instructions:
      - text: Move restriction group product addition {id} to restriction group {restrictionGroupId}.
        slots:
          id: path.id
          restrictionGroupId: requestBody.restrictionGroupId
      - text: Patch restriction group product addition {id} to point at product {productId}.
        slots:
          id: path.id
          productId: requestBody.productId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupProductAdditions/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Call the Default function on restriction group additions
      effect: read
      questions:
      - What does the Default function on restriction group product additions return?
      - Is there a Default operation for restriction group product additions?
      instructions:
      - text: Call the Default function on restriction group product additions.
      - text: Run the restriction group product additions Default operation and show the result.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/restrictiongroupproductadditions/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete restriction group product additions
      effect: destructive
      questions:
      - Can I pull many products out of restriction groups in one request?
      - How do I delete a batch of restriction group product additions by ID?
      instructions:
      - text: Delete the restriction group product additions with IDs {ids}.
        slots:
          ids: query.ids
      - text: Bulk remove restriction group product additions {ids} together.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/restrictiongroupproductadditions({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of a restriction group addition
      effect: read
      questions:
      - How can I read a custom property on a restriction group product addition?
      - Do restriction group product additions carry custom properties I can fetch by key?
      instructions:
      - text: Get custom property {custompropertyKey} of restriction group product addition {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show the value of custom property {custompropertyKey} on restriction group product addition {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'