Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reactor Data elements API

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

$.info

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

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

$.paths['/data_elements/{DATA_ELEMENT_ID}'].get

$.paths['/data_elements/{DATA_ELEMENT_ID}'].patch

$.paths['/data_elements/{DATA_ELEMENT_ID}/notes'].get

$.paths['/data_elements/{DATA_ELEMENT_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 Data elements API
  version: 1.0.0
extends: openapi/adobe-suite-data-elements-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: 6
- target: $.paths['/properties/{PROPERTY_ID}/data_elements'].get
  update:
    x-apievangelist-phrasing:
      intent: List a tag property's data elements
      effect: read
      questions:
      - Which data elements are defined on my tags property?
      - Can I list only the published or enabled data elements?
      - How do I find a data element on a property by its name?
      instructions:
      - text: List the data elements on tag property {PROPERTY_ID}.
        slots:
          PROPERTY_ID: path.PROPERTY_ID
      - text: Show data elements on property {PROPERTY_ID} with enabled {enabled} and published {published}.
        slots:
          PROPERTY_ID: path.PROPERTY_ID
          enabled: query.enabled
          published: query.published
      - text: Find the data element named {name} on property {PROPERTY_ID}.
        slots:
          name: query.name
          PROPERTY_ID: path.PROPERTY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/data_elements'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data element
      effect: write
      questions:
      - How do I add a new data element to a tags property?
      - Can I create a data element with its delegate extension and settings in one call?
      instructions:
      - text: Create a data element on property {PROPERTY_ID} with attributes {data}.
        slots:
          PROPERTY_ID: path.PROPERTY_ID
          data: requestBody.data
      - text: Add a new data element to tags property {PROPERTY_ID}.
        slots:
          PROPERTY_ID: path.PROPERTY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data_elements/{DATA_ELEMENT_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a data element
      effect: read
      questions:
      - What are the settings of one data element?
      - Can I fetch a data element by its ID?
      instructions:
      - text: Retrieve data element {DATA_ELEMENT_ID}.
        slots:
          DATA_ELEMENT_ID: path.DATA_ELEMENT_ID
      - text: Show me the configuration of data element {DATA_ELEMENT_ID}.
        slots:
          DATA_ELEMENT_ID: path.DATA_ELEMENT_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data_elements/{DATA_ELEMENT_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update or revise a data element
      effect: write
      questions:
      - Can I change a data element's settings or name?
      - Is it possible to create a new revision of a data element instead of editing in place?
      instructions:
      - text: Update data element {DATA_ELEMENT_ID} with {data}.
        slots:
          DATA_ELEMENT_ID: path.DATA_ELEMENT_ID
          data: requestBody.data
      - text: Revise data element {DATA_ELEMENT_ID} into a new revision.
        slots:
          DATA_ELEMENT_ID: path.DATA_ELEMENT_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data_elements/{DATA_ELEMENT_ID}/notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List notes on a data element
      effect: read
      questions:
      - What notes have been left on a data element?
      - Can I search a data element's notes for some text?
      instructions:
      - text: List the notes on data element {DATA_ELEMENT_ID}.
        slots:
          DATA_ELEMENT_ID: path.DATA_ELEMENT_ID
      - text: Find notes on data element {DATA_ELEMENT_ID} containing {text}.
        slots:
          DATA_ELEMENT_ID: path.DATA_ELEMENT_ID
          text: query.text
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data_elements/{DATA_ELEMENT_ID}/notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note to a data element
      effect: write
      questions:
      - How do I leave a note on a data element for my team?
      - Can I annotate a data element with a comment?
      instructions:
      - text: Add a note to data element {DATA_ELEMENT_ID} with the text I give you.
        slots:
          DATA_ELEMENT_ID: path.DATA_ELEMENT_ID
      - text: Annotate data element {DATA_ELEMENT_ID} with a new comment.
        slots:
          DATA_ELEMENT_ID: path.DATA_ELEMENT_ID
      method: generated
      generated: '2026-09-26'