Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Richtextnote API

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

$.info

$.paths['/richtextnote/{id}'].get

$.paths['/richtextnote'].get

$.paths['/richtextnote/count'].get

$.paths['/richtextnote/search'].get

$.paths['/richtextnote/report'].get

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 Adobe Workfront Richtextnote API
  version: 1.0.0
extends: openapi/adobe-suite-richtextnote-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: 5
- target: $.paths['/richtextnote/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single rich text note
      effect: read
      questions:
      - How do I read one rich text note in Workfront by ID?
      - Can I choose which fields come back for a rich text note?
      instructions:
      - text: Show rich text note {id}.
        slots:
          id: path.id
      - text: Get rich text note {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/richtextnote'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several rich text notes by ID
      effect: read
      questions:
      - Can I fetch multiple rich text notes in one call?
      - What's the bulk way to load rich text notes by their IDs?
      instructions:
      - text: Fetch rich text notes {id}.
        slots:
          id: query.id
      - text: Bulk get rich text notes {id} returning {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/richtextnote/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count rich text notes
      effect: read
      questions:
      - How many rich text notes are there?
      - Can I count rich text notes matching a filter?
      instructions:
      - text: Count all rich text notes.
      - text: Count rich text notes matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/richtextnote/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search rich text notes
      effect: read
      questions:
      - How do I find rich text notes that match certain conditions?
      - Can I page through rich text note search results?
      instructions:
      - text: Search rich text notes where {filters}.
        slots:
          filters: query.filters
      - text: Search rich text notes matching {filters} with list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/richtextnote/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report over rich text notes
      effect: read
      questions:
      - Can I get an aggregated report of rich text notes?
      - What does a rich text note report query return?
      instructions:
      - text: Run a rich text note report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Generate a rich text note report with list options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'