# 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 Products API
  version: 1.0.0
extends: openapi/optimizely-restriction-group-products-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/RestrictionGroupProducts'].get
  update:
    x-apievangelist-phrasing:
      intent: List products in restriction groups
      effect: read
      questions:
      - Which products are covered by our product restriction groups?
      - Can I filter restricted products to a single restriction group?
      - How many products sit in restriction groups overall?
      instructions:
      - text: List all restriction group products.
      - text: List restriction group products where {filter}.
        slots:
          filter: query.$filter
      - text: Show {top} restricted product entries starting after {skip}.
        slots:
          top: query.$top
          skip: query.$skip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupProducts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a product to a restriction group
      effect: write
      questions:
      - How do I restrict who can buy a product by adding it to a restriction group?
      - Can I put a product into a restriction group through the admin API?
      instructions:
      - text: Add product {productId} to restriction group {restrictionGroupId}.
        slots:
          productId: requestBody.productId
          restrictionGroupId: requestBody.restrictionGroupId
      - text: Restrict product {productId} under group {restrictionGroupId}.
        slots:
          productId: requestBody.productId
          restrictionGroupId: requestBody.restrictionGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupProducts({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a restriction group product entry
      effect: read
      questions:
      - Which product and restriction group does a given entry link?
      - Can I fetch one restriction group product record by its id?
      instructions:
      - text: Get restriction group product {id}.
        slots:
          id: path.id
      - text: Show the product and group on restriction entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupProducts({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a restriction group product entry
      effect: write
      questions:
      - Can I rewrite a restriction group product entry in full?
      - Does a full replace of a restricted product entry clear fields I omit?
      instructions:
      - text: Replace restriction entry {id} with product {productId} in group {restrictionGroupId}.
        slots:
          id: path.id
          productId: requestBody.productId
          restrictionGroupId: requestBody.restrictionGroupId
      - text: Overwrite the complete restriction group product record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupProducts({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a product from a restriction group
      effect: destructive
      questions:
      - How do I lift a restriction on a product by removing it from its group?
      - Can I make the removal conditional on an ETag?
      instructions:
      - text: Delete restriction group product {id}.
        slots:
          id: path.id
      - text: Remove restriction entry {id} only if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupProducts({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Move a restricted product to another group
      effect: write
      questions:
      - Can I move a restricted product into a different restriction group?
      - Is a partial update supported on restriction group product entries?
      instructions:
      - text: Move restriction entry {id} to group {restrictionGroupId}.
        slots:
          id: path.id
          restrictionGroupId: requestBody.restrictionGroupId
      - text: Patch restriction entry {id} to cover product {productId}.
        slots:
          id: path.id
          productId: requestBody.productId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupProducts/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Call the restriction group products Default function
      effect: read
      questions:
      - What does the Default function on restriction group products return?
      - Is there a default restricted product entry?
      instructions:
      - text: Call the Default function on restriction group products.
      - text: Fetch the default restriction group product result.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/restrictiongroupproducts/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk remove products from restriction groups
      effect: destructive
      questions:
      - Can I unrestrict many products at once by deleting their entries?
      - Is there a bulk delete by id list for restriction group products?
      instructions:
      - text: Delete restriction group products {ids}.
        slots:
          ids: query.ids
      - text: Bulk remove the restriction entries with ids {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/restrictiongroupproducts({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of a restricted product entry
      effect: read
      questions:
      - Can I read a custom property stored on a restriction group product?
      - Where is a custom value for a restricted product entry kept?
      instructions:
      - text: Get custom property {custompropertyKey} of restriction group product {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show custom value {custompropertyKey} on restriction entry {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'