Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reactor Rule components API

11 actions 11 updates phrasing extends openapi/adobe-suite-rule-components-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 11

$.info
$.paths['/rules/{RULE_ID}/rule_components'].get
$.paths['/rules/{RULE_ID}/rule_components'].post
$.paths['/rule_components/{RULE_COMPONENT_ID}'].get
$.paths['/rule_components/{RULE_COMPONENT_ID}'].delete
$.paths['/rule_components/{RULE_COMPONENT_ID}'].patch
$.paths['/rule_components/{RULE_COMPONENT_ID}/extension'].get
$.paths['/rule_components/{RULE_COMPONENT_ID}/origin'].get
$.paths['/rule_components/{RULE_COMPONENT_ID}/rules'].get
$.paths['/rule_components/{RULE_COMPONENT_ID}/notes'].get
$.paths['/rule_components/{RULE_COMPONENT_ID}/notes'].post

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 Reactor Rule components API
  version: 1.0.0
extends: openapi/adobe-suite-rule-components-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['/rules/{RULE_ID}/rule_components'].get
  update:
    x-apievangelist-phrasing:
      intent: List the components of a tag rule
      effect: read
      questions:
      - What events, conditions and actions make up a given tag rule?
      - Can I list a rule's components filtered to only enabled or published ones?
      instructions:
      - text: List the components of rule {rule}.
        slots:
          rule: path.RULE_ID
      - text: Show components of rule {rule} where enabled is {enabled}.
        slots:
          rule: path.RULE_ID
          enabled: query.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rules/{RULE_ID}/rule_components'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a component to a tag rule
      effect: write
      questions:
      - How do I add a new event, condition or action to a rule?
      - Can I create a rule component directly under an existing rule?
      instructions:
      - text: Add a new component to rule {rule}.
        slots:
          rule: path.RULE_ID
      - text: Create rule component {data} on rule {rule}.
        slots:
          data: requestBody.data
          rule: path.RULE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rule_components/{RULE_COMPONENT_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a rule component
      effect: read
      questions:
      - How do I look up one rule component's settings?
      - Can I see the details of a single event or action in a rule?
      instructions:
      - text: Show rule component {component}.
        slots:
          component: path.RULE_COMPONENT_ID
      - text: Get the settings of rule component {component}.
        slots:
          component: path.RULE_COMPONENT_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rule_components/{RULE_COMPONENT_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a rule component
      effect: destructive
      questions:
      - How do I remove a condition or action from a rule?
      - Can I delete a single rule component?
      instructions:
      - text: Delete rule component {component}.
        slots:
          component: path.RULE_COMPONENT_ID
      - text: Remove component {component} from its rule.
        slots:
          component: path.RULE_COMPONENT_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rule_components/{RULE_COMPONENT_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a rule component
      effect: write
      questions:
      - Can I change the settings of an existing rule component?
      - Does the ID in the body have to match the path when updating a rule component?
      instructions:
      - text: Update rule component {component}.
        slots:
          component: path.RULE_COMPONENT_ID
      - text: Patch rule component {component} with {data}.
        slots:
          component: path.RULE_COMPONENT_ID
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rule_components/{RULE_COMPONENT_ID}/extension'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the extension behind a rule component
      effect: read
      questions:
      - Which extension provides a particular rule component?
      - How do I tell what extension an action in my rule comes from?
      instructions:
      - text: Show the extension that provides rule component {component}.
        slots:
          component: path.RULE_COMPONENT_ID
      - text: Look up which extension rule component {component} belongs to.
        slots:
          component: path.RULE_COMPONENT_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rule_components/{RULE_COMPONENT_ID}/origin'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a rule component's origin
      effect: read
      questions:
      - What is the original revision a rule component was copied from?
      - Can I trace a rule component back to its origin?
      instructions:
      - text: Show the origin of rule component {component}.
        slots:
          component: path.RULE_COMPONENT_ID
      - text: Get the origin revision for rule component {component}.
        slots:
          component: path.RULE_COMPONENT_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rule_components/{RULE_COMPONENT_ID}/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List rules that use a rule component
      effect: read
      questions:
      - Which rules use a particular rule component?
      - Can I page through every rule that references one component?
      instructions:
      - text: List the rules using rule component {component}.
        slots:
          component: path.RULE_COMPONENT_ID
      - text: Show {size} rules per page that use component {component}.
        slots:
          size: query.page[size]
          component: path.RULE_COMPONENT_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rule_components/{RULE_COMPONENT_ID}/notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List notes on a rule component
      effect: read
      questions:
      - What notes have been left on a rule component?
      - Can I read the comments attached to one rule component?
      instructions:
      - text: List notes on rule component {component}.
        slots:
          component: path.RULE_COMPONENT_ID
      - text: Show page {number} of notes for rule component {component}.
        slots:
          number: query.page[number]
          component: path.RULE_COMPONENT_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rule_components/{RULE_COMPONENT_ID}/notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note to a rule component
      effect: write
      questions:
      - How do I leave a note on a rule component?
      - Can I attach a comment explaining a rule component change?
      instructions:
      - text: Add a note to rule component {component}.
        slots:
          component: path.RULE_COMPONENT_ID
      - text: Write a note on rule component {component} for the team.
        slots:
          component: path.RULE_COMPONENT_ID
      method: generated
      generated: '2026-09-26'