Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reactor Rules API

15 actions 15 updates phrasing extends openapi/adobe-suite-rules-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 15

$.info

$.paths['/properties/{PROPERTY_ID}/rules'].get

$.paths['/properties/{PROPERTY_ID}/rules'].post

$.paths['/rules/{RULE_ID}'].get

$.paths['/rules/{RULE_ID}'].delete

$.paths['/rules/{RULE_ID}'].patch

$.paths['/rules/{RULE_ID}/rule_components'].get

$.paths['/rules/{RULE_ID}/rule_components'].post

$.paths['/rules/{RULE_ID}/libraries'].get

$.paths['/rules/{RULE_ID}/property'].get

$.paths['/rules/{RULE_ID}/origin'].get

$.paths['/rules/{RULE_ID}/revisions'].get

$.paths['/rules/{RULE_ID}/rule_component_notes'].get

$.paths['/rules/{RULE_ID}/notes'].get

$.paths['/rules/{RULE_ID}/notes'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Reactor Rules API
  version: 1.0.0
extends: openapi/adobe-suite-rules-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: 14
- target: $.paths['/properties/{PROPERTY_ID}/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a tag property's rules
      effect: read
      questions:
      - Which rules are set up in my Adobe tags property?
      - Can I filter a property's rules to only enabled or published ones?
      - How do I find rules with unpublished changes in a property?
      instructions:
      - text: List the rules in property {PROPERTY_ID}.
        slots:
          PROPERTY_ID: path.PROPERTY_ID
      - text: Show rules in property {PROPERTY_ID} named {name}.
        slots:
          PROPERTY_ID: path.PROPERTY_ID
          name: query.name
      - text: List rules in property {PROPERTY_ID} where enabled is {enabled}.
        slots:
          PROPERTY_ID: path.PROPERTY_ID
          enabled: query.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a rule in a tag property
      effect: write
      questions:
      - How do I add a new rule to a tags property?
      - What attributes do I send to create a rule?
      instructions:
      - text: Create a rule in property {PROPERTY_ID}.
        slots:
          PROPERTY_ID: path.PROPERTY_ID
      - text: Add a new rule to property {PROPERTY_ID} using {data}.
        slots:
          PROPERTY_ID: path.PROPERTY_ID
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rules/{RULE_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tag rule's details
      effect: read
      questions:
      - What are the settings of a specific tag rule?
      - Can I look up one rule by its ID?
      instructions:
      - text: Get rule {RULE_ID}.
        slots:
          RULE_ID: path.RULE_ID
      - text: Show me the details of tag rule {RULE_ID}.
        slots:
          RULE_ID: path.RULE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rules/{RULE_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag rule
      effect: destructive
      questions:
      - How do I delete a rule from my tags property?
      - Can I remove a rule I no longer need?
      instructions:
      - text: Delete rule {RULE_ID}.
        slots:
          RULE_ID: path.RULE_ID
      - text: Remove tag rule {RULE_ID} permanently.
        slots:
          RULE_ID: path.RULE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rules/{RULE_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update or revise a tag rule
      effect: write
      questions:
      - How do I change a rule's name or enabled state?
      - Can I create a new revision of a rule when updating it?
      instructions:
      - text: Update rule {RULE_ID} with {data}.
        slots:
          RULE_ID: path.RULE_ID
          data: requestBody.data
      - text: Revise rule {RULE_ID} so it gets a new revision.
        slots:
          RULE_ID: path.RULE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rules/{RULE_ID}/rule_components'].get
  update:
    x-apievangelist-phrasing:
      intent: List a rule's components
      effect: read
      questions:
      - Which events, conditions and actions make up a rule?
      - Can I list only the negated components of a rule?
      instructions:
      - text: List the components of rule {RULE_ID}.
        slots:
          RULE_ID: path.RULE_ID
      - text: Show components of rule {RULE_ID} where negate is {negate}.
        slots:
          RULE_ID: path.RULE_ID
          negate: query.negate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rules/{RULE_ID}/rule_components'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a component to a rule
      effect: write
      questions:
      - How do I add an event, condition or action to a rule?
      - What relationships does a new rule component need?
      instructions:
      - text: Create a rule component on rule {RULE_ID}.
        slots:
          RULE_ID: path.RULE_ID
      - text: Add component {data} to rule {RULE_ID}.
        slots:
          data: requestBody.data
          RULE_ID: path.RULE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rules/{RULE_ID}/libraries'].get
  update:
    x-apievangelist-phrasing:
      intent: List libraries that include a rule
      effect: read
      questions:
      - Which libraries contain a particular rule?
      - Can I see every build library a rule has been added to?
      instructions:
      - text: List the libraries that use rule {RULE_ID}.
        slots:
          RULE_ID: path.RULE_ID
      - text: Show which libraries include rule {RULE_ID}, page size {page_size}.
        slots:
          RULE_ID: path.RULE_ID
          page_size: query.page[size]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rules/{RULE_ID}/property'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the property that owns a rule
      effect: read
      questions:
      - Which tags property does a given rule belong to?
      - Can I find the parent property of a rule?
      instructions:
      - text: Get the property that owns rule {RULE_ID}.
        slots:
          RULE_ID: path.RULE_ID
      - text: Find the parent property of rule {RULE_ID}.
        slots:
          RULE_ID: path.RULE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rules/{RULE_ID}/origin'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the origin of a revised rule
      effect: read
      questions:
      - Where do I find the original rule a revision came from?
      - Can I trace a rule revision back to its origin?
      instructions:
      - text: Get the origin of rule {RULE_ID}.
        slots:
          RULE_ID: path.RULE_ID
      - text: Show the original rule that revision {RULE_ID} came from.
        slots:
          RULE_ID: path.RULE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rules/{RULE_ID}/revisions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a rule's revisions
      effect: read
      questions:
      - What is the revision history of a rule?
      - Can I page through all past revisions of a rule?
      instructions:
      - text: List revisions of rule {RULE_ID}.
        slots:
          RULE_ID: path.RULE_ID
      - text: Show page {page_number} of revisions for rule {RULE_ID}.
        slots:
          RULE_ID: path.RULE_ID
          page_number: query.page[number]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rules/{RULE_ID}/rule_component_notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List notes on a rule's components
      effect: read
      questions:
      - What notes have been left on the components inside a rule?
      - Does listing component notes include notes on the rule itself?
      instructions:
      - text: List the component notes for rule {RULE_ID}.
        slots:
          RULE_ID: path.RULE_ID
      - text: Show notes on rule {RULE_ID}'s components containing {text}.
        slots:
          RULE_ID: path.RULE_ID
          text: query.text
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rules/{RULE_ID}/notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List notes on a rule
      effect: read
      questions:
      - What notes are attached directly to a rule?
      - Can I filter a rule's notes by text?
      instructions:
      - text: List the notes on rule {RULE_ID}.
        slots:
          RULE_ID: path.RULE_ID
      - text: Find notes on rule {RULE_ID} that mention {text}.
        slots:
          RULE_ID: path.RULE_ID
          text: query.text
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rules/{RULE_ID}/notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note to a rule
      effect: write
      questions:
      - How do I leave a note on a tag rule?
      - Can I annotate a rule for my team?
      instructions:
      - text: Add a note to rule {RULE_ID}.
        slots:
          RULE_ID: path.RULE_ID
      - text: Create a note on tag rule {RULE_ID} explaining the change.
        slots:
          RULE_ID: path.RULE_ID
      method: generated
      generated: '2026-09-26'