# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Workfront Note API
  version: 1.0.0
extends: openapi/adobe-suite-note-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: 12
- target: $.paths['/note/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one note or comment by ID
      effect: read
      questions:
      - How do I read a single Workfront comment when I have its ID?
      - Can I choose which fields come back for one note?
      instructions:
      - text: Show me note {id}.
        slots:
          id: path.id
      - text: Get comment {id} with just {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/note/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a note
      effect: write
      questions:
      - How do I change the text of a comment I already posted?
      - Can I edit one existing note and get back selected fields?
      instructions:
      - text: Update the text of note {id}.
        slots:
          id: path.id
      - text: Edit comment {id} and return {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/note/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a note
      effect: destructive
      questions:
      - How do I delete a comment I posted by mistake?
      - Is there a force option when deleting a single note?
      instructions:
      - text: Delete note {id}.
        slots:
          id: path.id
      - text: Force delete comment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/note'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several notes by ID
      effect: read
      questions:
      - Can I load a batch of comments in one request by their IDs?
      - Is there a way to get many notes at once?
      instructions:
      - text: Fetch notes {ids} together.
        slots:
          ids: query.id
      - text: Load comments {ids} and include {fields}.
        slots:
          ids: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/note'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk edit notes
      effect: write
      questions:
      - Can I update many comments in one bulk request?
      - How do I mass-edit a set of notes?
      instructions:
      - text: Bulk update these notes with my changes.
      - text: Mass edit the comments and return {fields} for each.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/note'].post
  update:
    x-apievangelist-phrasing:
      intent: Post a new note or comment
      effect: write
      questions:
      - How do I add a comment to a task, issue or project?
      - Can I post an update note through the API?
      instructions:
      - text: Post a new comment with the text I give you.
      - text: Add a note and return {fields} once it is created.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/note'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete notes
      effect: destructive
      questions:
      - Can I delete several comments at once?
      - Is there a bulk way to clear out notes?
      instructions:
      - text: Delete all of notes {ids}.
        slots:
          ids: query.id
      - text: Remove the batch of comments {ids}.
        slots:
          ids: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/note/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count notes
      effect: read
      questions:
      - How many comments exist in total?
      - Can I count only notes that match a filter, like a given author?
      instructions:
      - text: Count all notes.
      - text: Tell me how many comments match {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/note/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search notes and comments
      effect: read
      questions:
      - How do I find comments that match certain criteria?
      - Can I sort and page through note search results?
      instructions:
      - text: Search notes where {filters}.
        slots:
          filters: query.filters
      - text: Find comments matching {filters} and show {fields}.
        slots:
          filters: query.filters
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/note/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an aggregated report on notes
      effect: read
      questions:
      - Can I get grouped report numbers about comments?
      - What report options summarize note activity?
      instructions:
      - text: Run a notes report for {filters}.
        slots:
          filters: query.filters
      - text: Produce an aggregated comments report using options {options}.
        slots:
          options: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/note/like'].put
  update:
    x-apievangelist-phrasing:
      intent: Like a note
      effect: write
      questions:
      - How do I like someone's comment?
      - Can I react to a note with a like through the API?
      instructions:
      - text: Like note {note}.
        slots:
          note: query.ID
      - text: Add my like to comment {note}.
        slots:
          note: query.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/note/unlike'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove a like from a note
      effect: write
      questions:
      - How do I take back a like I put on a comment?
      - Can I unlike a note?
      instructions:
      - text: Unlike note {note}.
        slots:
          note: query.ID
      - text: Remove my like from comment {note}.
        slots:
          note: query.ID
      method: generated
      generated: '2026-09-26'