Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Notetag API

6 actions 6 updates phrasing extends openapi/adobe-suite-notetag-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['/notetag/{id}'].get

$.paths['/notetag'].get

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

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

$.paths['/notetag/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 Notetag API
  version: 1.0.0
extends: openapi/adobe-suite-notetag-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['/notetag/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one note tag
      effect: read
      questions:
      - How do I look up a single note tag in Workfront?
      - Can I read one note tag with specific fields?
      instructions:
      - text: Show note tag {id}.
        slots:
          id: path.id
      - text: Get note tag {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notetag'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several note tags by ID
      effect: read
      questions:
      - Can I load multiple note tags at once by ID?
      - Is there a bulk get for note tags, the mentions attached to notes?
      instructions:
      - text: Fetch note tags {id}.
        slots:
          id: query.id
      - text: Bulk-load note tags {id} with fields {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notetag/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count note tags
      effect: read
      questions:
      - How many note tags match a filter?
      - Can I count note tags without listing them?
      instructions:
      - text: Count note tags matching {filters}.
        slots:
          filters: query.filters
      - text: Tell me the total number of note tags.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notetag/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search note tags
      effect: read
      questions:
      - What's the way to search note tags by field value?
      - Can I sort and page note tag search results?
      instructions:
      - text: Search note tags where {filters}.
        slots:
          filters: query.filters
      - text: Find note tags matching {filters} with list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notetag/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report on note tags
      effect: read
      questions:
      - Can I get a grouped report of note tags?
      - How do I aggregate note tags by a field?
      instructions:
      - text: Run a note tag report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Build a note tag report with options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'