Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Restriction Group Websites API

10 actions 10 updates phrasing extends openapi/optimizely-restriction-group-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/RestrictionGroupWebsites'].get
$.paths['/api/v1/admin/RestrictionGroupWebsites'].post
$.paths['/api/v1/admin/RestrictionGroupWebsites({id})'].get
$.paths['/api/v1/admin/RestrictionGroupWebsites({id})'].put
$.paths['/api/v1/admin/RestrictionGroupWebsites({id})'].delete
$.paths['/api/v1/admin/RestrictionGroupWebsites({id})'].patch
$.paths['/api/v1/admin/RestrictionGroupWebsites/Default.Default()'].get
$.paths['/api/v1/admin/restrictiongroupwebsites/delete'].delete
$.paths['/api/v1/admin/restrictiongroupwebsites({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 Websites API
  version: 1.0.0
extends: openapi/optimizely-restriction-group-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/RestrictionGroupWebsites'].get
  update:
    x-apievangelist-phrasing:
      intent: List restriction group website links
      effect: read
      questions:
      - Which websites are product restriction groups applied to?
      - Can I filter restriction group assignments to a single website?
      instructions:
      - text: List restriction group website assignments.
      - text: List restriction group websites matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupWebsites'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a restriction group to a website
      effect: write
      questions:
      - How do I apply a product restriction group to one of my storefront websites?
      - Can I link an existing restriction group to another website?
      instructions:
      - text: Apply restriction group {restrictionGroupId} to website {websiteId}.
        slots:
          restrictionGroupId: requestBody.restrictionGroupId
          websiteId: requestBody.websiteId
      - text: Link website {websiteId} with restriction group {restrictionGroupId}.
        slots:
          websiteId: requestBody.websiteId
          restrictionGroupId: requestBody.restrictionGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupWebsites({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a restriction group website link
      effect: read
      questions:
      - Can I look up one restriction group to website link by id?
      - Which restriction group and website does a given link connect?
      instructions:
      - text: Get restriction group website {id}.
        slots:
          id: path.id
      - text: Show the group and site behind link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupWebsites({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a restriction group website link
      effect: write
      questions:
      - Is there a way to overwrite a restriction group website link entirely?
      - What does a full replace of a restriction group website record need?
      instructions:
      - text: Replace link {id} so restriction group {restrictionGroupId} applies to website {websiteId}.
        slots:
          id: path.id
          restrictionGroupId: requestBody.restrictionGroupId
          websiteId: requestBody.websiteId
      - text: Overwrite restriction group website record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupWebsites({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a restriction group from a website
      effect: destructive
      questions:
      - Can I stop a restriction group applying to a website by deleting the link?
      - Does removing one restriction group website link support If-Match?
      instructions:
      - text: Delete restriction group website {id}.
        slots:
          id: path.id
      - text: Delete restriction group link {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/RestrictionGroupWebsites({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a restriction group website link
      effect: write
      questions:
      - How do I move a restriction group link to a different website?
      - Can I patch only the restriction group on an existing website link?
      instructions:
      - text: Point restriction link {id} at website {websiteId}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
      - text: Switch link {id} to restriction group {restrictionGroupId}.
        slots:
          id: path.id
          restrictionGroupId: requestBody.restrictionGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupWebsites/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank restriction group website template
      effect: read
      questions:
      - What default values does a new restriction group website link start with?
      - Is there an empty template for linking a restriction group to a site?
      instructions:
      - text: Get the default restriction group website template.
      - text: Show starting values for a new restriction group website link.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/restrictiongroupwebsites/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk remove restriction group website links
      effect: destructive
      questions:
      - Can I delete many restriction group website links in one request?
      - Is there a bulk delete that takes a list of restriction link ids?
      instructions:
      - text: Bulk delete restriction group websites {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these restriction group links in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/restrictiongroupwebsites({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a restriction group link
      effect: read
      questions:
      - How can I read a custom property on a restriction group website link?
      - Can extra metadata on a restriction group website record be fetched by property id?
      instructions:
      - text: Get custom property {custompropertyKey} on restriction group website {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Read restriction link {key}'s custom field {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'