# 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-suite-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: Get a single note
      effect: read
      questions:
      - How do I read one tags note if I have its ID?
      - What does a specific note say and when was it written?
      instructions:
      - text: Show me note {note}.
        slots:
          note: path.NOTE_ID
      - text: Get 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 the notes on a tags property
      effect: read
      questions:
      - What notes has my team left on this tags property?
      - Can I search a property's notes for a keyword?
      instructions:
      - text: List the notes on property {property}.
        slots:
          property: path.PROPERTY_ID
      - text: Find notes on property {property} mentioning {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 tags property
      effect: write
      questions:
      - How do I leave a note on a whole tags property?
      - Can I document a change at the property level with a note?
      instructions:
      - text: Add a note to property {property}.
        slots:
          property: path.PROPERTY_ID
      - text: Write a note on property {property} about this setup.
        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 the notes on a data element
      effect: read
      questions:
      - Are there any notes explaining what this data element captures?
      - 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 notes on data element {data_element} that mention {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 annotate a data element with a note?
      - Can I explain a data element's purpose in a note for others?
      instructions:
      - text: Add a note to data element {data_element}.
        slots:
          data_element: path.DATA_ELEMENT_ID
      - text: Annotate data element {data_element} with a note.
        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 the notes on a secret
      effect: read
      questions:
      - What notes are attached to this event forwarding secret?
      - Can I look for 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} containing {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 a note against a secret, like who owns it?
      - Can I leave a note on a secret without changing the secret itself?
      instructions:
      - text: Add a note to secret {secret}.
        slots:
          secret: path.SECRET_ID
      - text: Record a note on secret {secret} about its rotation.
        slots:
          secret: path.SECRET_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/extensions/{EXTENSION_ID}/notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List the notes on an extension
      effect: read
      questions:
      - What notes exist for this installed extension?
      - How do I page through comments on an extension?
      instructions:
      - text: List the notes on extension {extension}.
        slots:
          extension: path.EXTENSION_ID
      - text: Show all notes left on extension {extension}.
        slots:
          extension: path.EXTENSION_ID
      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 note on an installed extension?
      - Can I explain why an extension was configured a certain way in a note?
      instructions:
      - text: Add a note to extension {extension}.
        slots:
          extension: path.EXTENSION_ID
      - text: Explain the configuration of extension {extension} in a new note.
        slots:
          extension: path.EXTENSION_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/libraries/{LIBRARY_ID}/notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List the notes on a library
      effect: read
      questions:
      - What release notes were left on this library?
      - Can I search a library's notes for specific text?
      instructions:
      - text: List the notes on library {library}.
        slots:
          library: path.LIBRARY_ID
      - text: Find notes on library {library} 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 leave release notes on a library?
      - Can I comment on a library before it gets published?
      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 the notes on a rule
      effect: read
      questions:
      - What comments have people left on this tag rule?
      - Can I filter a rule's notes by update date?
      instructions:
      - text: List the notes on rule {rule}.
        slots:
          rule: path.RULE_ID
      - text: Find notes on rule {rule} mentioning {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 why a tag rule exists with a note?
      - Can I comment on a rule through the API?
      instructions:
      - text: Add a note to rule {rule}.
        slots:
          rule: path.RULE_ID
      - text: Document the purpose of rule {rule} in a note.
        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 the notes on a rule component
      effect: read
      questions:
      - Which notes were written about a specific event, condition or action inside a rule?
      - Can I search the notes on one rule component by keyword?
      instructions:
      - text: List the notes on rule component {component}.
        slots:
          component: path.RULE_COMPONENT_ID
      - text: Find notes on rule component {component} that contain {text}.
        slots:
          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 single condition or action within a rule?
      - Can I attach a note to one rule component rather than the whole rule?
      instructions:
      - text: Add a note to rule component {component}.
        slots:
          component: path.RULE_COMPONENT_ID
      - text: Annotate rule component {component} with an explanation.
        slots:
          component: path.RULE_COMPONENT_ID
      method: generated
      generated: '2026-09-26'