# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Reactor Notes API
  version: 1.0.0
extends: openapi/adobe-launch-notes-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: 15
- target: $.paths['/notes/{NOTE_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a note by ID
      effect: read
      questions:
      - How do I read a single tags note when I have its ID?
      - Can I see who wrote a specific note and when?
      instructions:
      - text: Get note {note}.
        slots:
          note: path.NOTE_ID
      - text: Show me the text of note {note}.
        slots:
          note: path.NOTE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List notes on a property
      effect: read
      questions:
      - What notes have been left on my tags property?
      - Can I search a property's notes for a phrase?
      instructions:
      - text: List the notes on property {property}.
        slots:
          property: path.PROPERTY_ID
      - text: Find property {property} notes that mention {text}.
        slots:
          property: path.PROPERTY_ID
          text: query.text
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note to a property
      effect: write
      questions:
      - How do I leave a note on a whole tags property?
      - Can I annotate a property with context for my team?
      instructions:
      - text: Add a note to property {property}.
        slots:
          property: path.PROPERTY_ID
      - text: Leave a property-level note on {property} about this change.
        slots:
          property: path.PROPERTY_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 are attached to this data element?
      - Can I filter a data element's notes by when they were created?
      instructions:
      - text: List the notes on data element {data_element}.
        slots:
          data_element: path.DATA_ELEMENT_ID
      - text: Find data element {data_element} notes containing {text}.
        slots:
          data_element: 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 document why a data element is set up the way it is?
      - Can I comment on a data element?
      instructions:
      - text: Add a note to data element {data_element}.
        slots:
          data_element: path.DATA_ELEMENT_ID
      - text: Leave an explanation note on data element {data_element}.
        slots:
          data_element: path.DATA_ELEMENT_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/secrets/{SECRET_ID}/notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List notes on a secret
      effect: read
      questions:
      - What notes are on this event forwarding secret?
      - Can I search a secret's notes by text?
      instructions:
      - text: List the notes on secret {secret}.
        slots:
          secret: path.SECRET_ID
      - text: Find notes on secret {secret} mentioning {text}.
        slots:
          secret: path.SECRET_ID
          text: query.text
      method: generated
      generated: '2026-09-26'
- target: $.paths['/secrets/{SECRET_ID}/notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note to a secret
      effect: write
      questions:
      - How do I record who owns a secret or when it rotates?
      - Can I attach a note to a secret?
      instructions:
      - text: Add a note to secret {secret}.
        slots:
          secret: path.SECRET_ID
      - text: Leave a rotation note on secret {secret}.
        slots:
          secret: path.SECRET_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/extensions/{EXTENSION_ID}/notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List notes on an extension
      effect: read
      questions:
      - What notes have been added to this extension?
      - Can I page through an extension's notes?
      instructions:
      - text: List the notes on extension {extension}.
        slots:
          extension: path.EXTENSION_ID
      - text: Show page {page} of extension {extension} notes.
        slots:
          extension: path.EXTENSION_ID
          page: query.page[number]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/extensions/{EXTENSION_ID}/notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note to an extension
      effect: write
      questions:
      - How do I leave a comment on an installed extension?
      - Can I note why an extension's settings were changed?
      instructions:
      - text: Add a note to extension {extension}.
        slots:
          extension: path.EXTENSION_ID
      - text: Leave a settings note on extension {extension}.
        slots:
          extension: path.EXTENSION_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List notes on a library
      effect: read
      questions:
      - What review notes are on this library?
      - Can I filter a library's notes by text?
      instructions:
      - text: List the notes on library {library}.
        slots:
          library: path.LIBRARY_ID
      - text: Find library {library} notes that mention {text}.
        slots:
          library: path.LIBRARY_ID
          text: query.text
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note to a library
      effect: write
      questions:
      - How do I add release notes to a library?
      - Can I leave a note for the approver of a library?
      instructions:
      - text: Add a note to library {library}.
        slots:
          library: path.LIBRARY_ID
      - text: Leave release notes on library {library}.
        slots:
          library: path.LIBRARY_ID
      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 to this rule?
      - Can I search a rule's notes for a keyword?
      instructions:
      - text: List the notes on rule {rule}.
        slots:
          rule: path.RULE_ID
      - text: Find rule {rule} notes containing {text}.
        slots:
          rule: 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 document what a rule is for?
      - Can I comment on a rule so others know why it fires?
      instructions:
      - text: Add a note to rule {rule}.
        slots:
          rule: path.RULE_ID
      - text: Leave a note on rule {rule} explaining its purpose.
        slots:
          rule: path.RULE_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 are on this rule component, like an event or action?
      - Can I filter a rule component's notes by update time?
      instructions:
      - text: List the notes on rule component {rule_component}.
        slots:
          rule_component: path.RULE_COMPONENT_ID
      - text: Find rule component {rule_component} notes mentioning {text}.
        slots:
          rule_component: path.RULE_COMPONENT_ID
          text: query.text
      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 annotate a specific action or condition within a rule?
      - Can I leave a note on a rule component?
      instructions:
      - text: Add a note to rule component {rule_component}.
        slots:
          rule_component: path.RULE_COMPONENT_ID
      - text: Leave a note on rule component {rule_component} describing its setup.
        slots:
          rule_component: path.RULE_COMPONENT_ID
      method: generated
      generated: '2026-09-26'