Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Rule Clause Customers API

10 actions 10 updates phrasing extends openapi/optimizely-rule-clause-customers-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/RuleClauseCustomers'].get
$.paths['/api/v1/admin/RuleClauseCustomers'].post
$.paths['/api/v1/admin/RuleClauseCustomers({id})'].get
$.paths['/api/v1/admin/RuleClauseCustomers({id})'].put
$.paths['/api/v1/admin/RuleClauseCustomers({id})'].delete
$.paths['/api/v1/admin/RuleClauseCustomers({id})'].patch
$.paths['/api/v1/admin/RuleClauseCustomers/Default.Default()'].get
$.paths['/api/v1/admin/ruleclausecustomers/delete'].delete
$.paths['/api/v1/admin/ruleclausecustomers({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 Rule Clause Customers API
  version: 1.0.0
extends: openapi/optimizely-rule-clause-customers-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/RuleClauseCustomers'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers attached to rule clauses
      effect: read
      questions:
      - Which customers are targeted by rule clauses in my Optimizely commerce rules?
      - Can I filter rule clause customers to one rule clause?
      instructions:
      - text: List all rule clause customer links.
      - text: List rule clause customers matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RuleClauseCustomers'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a customer to a rule clause
      effect: write
      questions:
      - How do I make a rule clause apply to a specific customer?
      - Can I link a customer to an existing rule clause?
      instructions:
      - text: Attach customer {customerId} to rule clause {ruleClauseId}.
        slots:
          customerId: requestBody.customerId
          ruleClauseId: requestBody.ruleClauseId
      - text: Add rule clause {ruleClauseId} targeting customer {customerId}.
        slots:
          customerId: requestBody.customerId
          ruleClauseId: requestBody.ruleClauseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RuleClauseCustomers({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a rule clause customer link
      effect: read
      questions:
      - Which customer and rule clause does a given link record connect?
      - How do I fetch one rule clause customer by id?
      instructions:
      - text: Get rule clause customer {id}.
        slots:
          id: path.id
      - text: Show the customer and clause behind link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RuleClauseCustomers({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a rule clause customer link
      effect: write
      questions:
      - How do I overwrite a rule clause customer record?
      - Can I replace both the clause and customer on a link?
      instructions:
      - text: Replace rule clause customer {id} with clause {ruleClauseId} and customer {customerId}.
        slots:
          id: path.id
          ruleClauseId: requestBody.ruleClauseId
          customerId: requestBody.customerId
      - text: Fully overwrite rule clause customer link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RuleClauseCustomers({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach a customer from a rule clause
      effect: destructive
      questions:
      - How do I stop a rule clause from applying to a customer?
      - Can I delete a rule clause customer link with an ETag guard?
      instructions:
      - text: Delete rule clause customer {id}.
        slots:
          id: path.id
      - text: Delete rule clause customer 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/RuleClauseCustomers({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change the customer on a rule clause link
      effect: write
      questions:
      - How do I switch a rule clause link to a different customer?
      - Can I move a customer link to another rule clause?
      instructions:
      - text: Change the customer on rule clause link {id} to {customerId}.
        slots:
          id: path.id
          customerId: requestBody.customerId
      - text: Point rule clause customer {id} at rule clause {ruleClauseId}.
        slots:
          id: path.id
          ruleClauseId: requestBody.ruleClauseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RuleClauseCustomers/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank default rule clause customer
      effect: read
      questions:
      - What does an empty rule clause customer object contain?
      - Is there a template for a new rule clause customer link?
      instructions:
      - text: Get the default template for a new rule clause customer.
      - text: Show the blank rule clause customer object.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ruleclausecustomers/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several rule clause customer links
      effect: destructive
      questions:
      - Can I remove many rule clause customer links at once?
      - How do I bulk-delete rule clause customers by id?
      instructions:
      - text: Delete rule clause customers {ids}.
        slots:
          ids: query.ids
      - text: Bulk-remove rule clause customer links with ids {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ruleclausecustomers({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a rule clause customer custom property
      effect: read
      questions:
      - How do I read a custom property on a rule clause customer?
      - Can rule clause customer links carry custom properties?
      instructions:
      - text: Get custom property {custompropertyKey} of rule clause customer {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show rule clause customer {key}'s custom property {custompropertyKey}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'