API Evangelist conversational phrasing for Admin API V1 Rule Types 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 Types API
  version: 1.0.0
extends: openapi/optimizely-rule-types-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: 10
- target: $.paths['/api/v1/admin/RuleTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List rule types
      effect: read
      questions:
      - Which rule types are available for building promotion and pricing rules?
      - Can I sort or filter the list of rule types by name?
      instructions:
      - text: List all rule types.
      - text: Find rule types matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RuleTypes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a rule type
      effect: write
      questions:
      - How do I add a new rule type?
      - Is a name the only required field for a new rule type?
      instructions:
      - text: Create a rule type named {name}.
        slots:
          name: requestBody.name
      - text: Add rule type {name} to the admin.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RuleTypes({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a rule type
      effect: read
      questions:
      - Can I look up one rule type by its ID?
      - What does a single rule type record hold?
      instructions:
      - text: Show rule type {id}.
        slots:
          id: path.id
      - text: Get rule type {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RuleTypes({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a rule type
      effect: write
      questions:
      - How do I overwrite a rule type record in full?
      - Does replacing a rule type mean resending its name?
      instructions:
      - text: Replace rule type {id} with name {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Overwrite the whole record of rule type {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RuleTypes({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a rule type
      effect: destructive
      questions:
      - How do I permanently delete one rule type?
      - Can a rule type delete be guarded by an ETag?
      instructions:
      - text: Delete rule type {id}.
        slots:
          id: path.id
      - text: Delete rule type {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/RuleTypes({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a rule type
      effect: write
      questions:
      - Can I change just the name of an existing rule type?
      - What's the way to partially update a rule type?
      instructions:
      - text: Rename rule type {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Patch rule type {id} with a new name {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RuleTypes/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new rule type
      effect: read
      questions:
      - What defaults does a new rule type start with?
      - Is there a blank rule type template?
      instructions:
      - text: Get the default rule type template.
      - text: Show prefilled defaults for a new rule type.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ruletypes/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete rule types
      effect: destructive
      questions:
      - Can I delete several rule types at once by ID?
      - How do I bulk remove unused rule types?
      instructions:
      - text: Bulk delete rule types {ids}.
        slots:
          ids: query.ids
      - text: Permanently remove the rule types with IDs {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ruletypes({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a rule type
      effect: read
      questions:
      - Can I read a custom property stored on a rule type?
      - Where are extra custom fields for a rule type kept?
      instructions:
      - text: Show custom property {property} on rule type {key}.
        slots:
          property: path.custompropertyKey
          key: path.key
      - text: Get rule type {key}'s custom field {property}.
        slots:
          property: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ruletypes({key})/ruletypeoptions({ruletypeoptionKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an option of a rule type
      effect: read
      questions:
      - What options does a rule type offer, and can I read one of them?
      - Can I look up a single rule type option?
      instructions:
      - text: Show option {option} of rule type {key}.
        slots:
          option: path.ruletypeoptionKey
          key: path.key
      - text: Get rule type option {option} under rule type {key}.
        slots:
          option: path.ruletypeoptionKey
          key: path.key
      method: generated
      generated: '2026-09-26'