API Evangelist conversational phrasing for Admin API V1 Rule Type Options API

# 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 Type Options API
  version: 1.0.0
extends: openapi/optimizely-rule-type-options-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/RuleTypeOptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List rule type criteria options
      effect: read
      questions:
      - What criteria options can rules be built from in Optimizely Commerce?
      - Can I filter rule type options to a single rule type?
      instructions:
      - text: List all rule type options.
      - text: Show rule type options matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RuleTypeOptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a criteria option to a rule type
      effect: write
      questions:
      - How do I define a new criterion that rules of a given type can check?
      - Which object, property and value type does a rule criterion option need?
      instructions:
      - text: Add a {criteriaType} option on {criteriaObject}.{criteriaProperty} of type {valueType}, described as {description}.
        slots:
          criteriaType: requestBody.criteriaType
          criteriaObject: requestBody.criteriaObject
          criteriaProperty: requestBody.criteriaProperty
          valueType: requestBody.valueType
          description: requestBody.description
      - text: Create a criteria option for rule type {ruleTypeId} checking property {criteriaProperty}.
        slots:
          ruleTypeId: requestBody.ruleTypeId
          criteriaProperty: requestBody.criteriaProperty
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RuleTypeOptions({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one rule type option
      effect: read
      questions:
      - What property and value type does a specific rule criteria option check?
      - Can I look up one rule type option by id?
      instructions:
      - text: Fetch rule type option {id}.
        slots:
          id: path.id
      - text: Show the criteria object and property of rule option {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RuleTypeOptions({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a rule type option
      effect: write
      questions:
      - Can I overwrite a rule criteria option entirely?
      - Does replacing a rule type option mean resending every criteria field?
      instructions:
      - text: Replace rule type option {id} with criteria type {criteriaType} and value type {valueType}.
        slots:
          id: path.id
          criteriaType: requestBody.criteriaType
          valueType: requestBody.valueType
      - text: Overwrite the full definition of rule type option {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RuleTypeOptions({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one rule type option
      effect: destructive
      questions:
      - How do I remove a criteria option from a rule type?
      - Can deleting a rule type option be guarded by an ETag?
      instructions:
      - text: Delete rule type option {id}.
        slots:
          id: path.id
      - text: Delete rule option {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/RuleTypeOptions({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a rule type option's criteria
      effect: write
      questions:
      - Can I change just the description shown for a rule criteria option?
      - Is it possible to switch the property an existing rule option checks?
      instructions:
      - text: Change the description of rule type option {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      - text: Point rule option {id} at property {criteriaProperty}.
        slots:
          id: path.id
          criteriaProperty: requestBody.criteriaProperty
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RuleTypeOptions/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a rule type option
      effect: read
      questions:
      - What defaults does a new rule type option start with?
      - Is there a blank rule criteria option template?
      instructions:
      - text: Get the default field values for a new rule type option.
      - text: Show the empty rule criteria option template.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ruletypeoptions/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete rule type options
      effect: destructive
      questions:
      - Can I remove many rule type options in one request?
      - Is there a batch delete for rule criteria options by id list?
      instructions:
      - text: Bulk delete rule type options {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every rule option in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ruletypeoptions({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a rule type option
      effect: read
      questions:
      - How can I read a custom property stored on a rule type option?
      - Can I fetch one custom field value from a rule criteria option?
      instructions:
      - text: Get custom property {custompropertyKey} of rule type option {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show the {custompropertyKey} custom property on rule option {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'