Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Update API

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

$.info
$.paths['/update/auditSessionCount'].put
$.paths['/update/recentUpdatesObjIDs'].put
$.paths['/update/auditSession'].get
$.paths['/update/endorsementUpdates'].get
$.paths['/update/objectUpdates'].get
$.paths['/update/objectUpdatesByCommentID'].get
$.paths['/update/objectUpdatesMobile'].get
$.paths['/update/objectUpdatesWithNoteAndJournalEntryIndex'].get
$.paths['/update/recentUpdates'].get
$.paths['/update/updateThread'].get
$.paths['/update/updateThreadMobile'].get
$.paths['/update/updates'].get

OpenAPI Overlay

Raw ↑
# 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 Update API
  version: 1.0.0
extends: openapi/adobe-suite-update-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['/update/auditSessionCount'].put
  update:
    x-apievangelist-phrasing:
      intent: Count audit sessions for a user
      effect: read
      questions:
      - How many audit sessions did a user have in a date range?
      - Can I count audit sessions for a target user?
      instructions:
      - text: Count audit sessions for user {targetUserID} from {startDate} to {endDate}.
        slots:
          targetUserID: query.targetUserID
          startDate: query.startDate
          endDate: query.endDate
      - text: Get the audit session count for user {userID}.
        slots:
          userID: query.userID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/update/recentUpdatesObjIDs'].put
  update:
    x-apievangelist-phrasing:
      intent: Get IDs of recently updated objects
      effect: read
      questions:
      - Which objects have recent updates?
      - Can I get only the IDs of objects in my recent updates?
      instructions:
      - text: Get the object IDs from my recent updates.
      - text: List IDs of objects with recent update activity.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/update/auditSession'].get
  update:
    x-apievangelist-phrasing:
      intent: Get audit session activity
      effect: read
      questions:
      - What did a user change during their audit sessions?
      - Can I page through audit sessions between two dates?
      instructions:
      - text: Show audit sessions for user {targetUserID} between {startDate} and {endDate}.
        slots:
          targetUserID: query.targetUserID
          startDate: query.startDate
          endDate: query.endDate
      - text: Get page {pageNumber} of audit sessions for user {userID}.
        slots:
          pageNumber: query.pageNumber
          userID: query.userID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/update/endorsementUpdates'].get
  update:
    x-apievangelist-phrasing:
      intent: Get endorsement updates
      effect: read
      questions:
      - What endorsements has a user received lately?
      - Can I see the update feed for endorsements?
      instructions:
      - text: Get endorsement updates for user {userID}.
        slots:
          userID: query.userID
      - text: Show endorsement updates matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/update/objectUpdates'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the update feed for an object
      effect: read
      questions:
      - What updates have been posted on a specific project or task?
      - Can I get an object's updates since a certain date?
      instructions:
      - text: Get updates on {objCode} {objID}.
        slots:
          objCode: query.objCode
          objID: query.objID
      - text: Show updates on {objCode} {objID} since {sinceDate}.
        slots:
          objCode: query.objCode
          objID: query.objID
          sinceDate: query.sinceDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/update/objectUpdatesByCommentID'].get
  update:
    x-apievangelist-phrasing:
      intent: Get object updates around a comment
      effect: read
      questions:
      - Can I load an object's update feed positioned at a particular comment?
      - How do I find the updates tied to one comment on a task?
      instructions:
      - text: Get updates on {objCode} {objID} for comment {commentID}.
        slots:
          objCode: query.objCode
          objID: query.objID
          commentID: query.commentID
      - text: Show the update feed around comment {commentID}.
        slots:
          commentID: query.commentID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/update/objectUpdatesMobile'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an object's updates for mobile
      effect: read
      questions:
      - Is there a mobile-formatted feed of updates for an object?
      - Can the mobile app pull an object's updates since a date?
      instructions:
      - text: Get mobile updates for {objCode} {objID}.
        slots:
          objCode: query.objCode
          objID: query.objID
      - text: Fetch the mobile update feed of {objCode} {objID} since {sinceDate}.
        slots:
          objCode: query.objCode
          objID: query.objID
          sinceDate: query.sinceDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/update/objectUpdatesWithNoteAndJournalEntryIndex'].get
  update:
    x-apievangelist-phrasing:
      intent: Get object updates from a note/journal index
      effect: read
      questions:
      - Can I page an object's updates starting from a given note and journal entry?
      - How do I resume an update feed from a specific note index?
      instructions:
      - text: Get updates on {objCode} {objID} starting at note {firstNote} and journal entry {firstJournalEntry}.
        slots:
          objCode: query.objCode
          objID: query.objID
          firstNote: query.firstNote
          firstJournalEntry: query.firstJournalEntry
      - text: Continue the update feed of {objID} from note index {firstNote}.
        slots:
          objID: query.objID
          firstNote: query.firstNote
      method: generated
      generated: '2026-09-26'
- target: $.paths['/update/recentUpdates'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my recent updates
      effect: read
      questions:
      - What has changed recently across the work I follow?
      - Can I see recent updates since a particular date?
      instructions:
      - text: Show my recent updates.
      - text: Get recent updates since {sinceDate}.
        slots:
          sinceDate: query.sinceDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/update/updateThread'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a note's reply thread
      effect: read
      questions:
      - How do I see all replies to a specific update note?
      - Can I load the full conversation thread for a comment?
      instructions:
      - text: Get the update thread for note {noteID}.
        slots:
          noteID: query.noteID
      - text: Show all replies under note {noteID}.
        slots:
          noteID: query.noteID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/update/updateThreadMobile'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a note's reply thread for mobile
      effect: read
      questions:
      - Is there a mobile version of a note's reply thread?
      - Can the mobile app fetch a comment thread by note ID?
      instructions:
      - text: Load the mobile-formatted reply thread of note {noteID}.
        slots:
          noteID: query.noteID
      - text: Fetch replies to note {noteID} in mobile format.
        slots:
          noteID: query.noteID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/update/updates'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an update stream by type
      effect: read
      questions:
      - Which update stream types can I pull?
      - Can I filter the updates stream by stream type?
      instructions:
      - text: Get the {streamType} update stream.
        slots:
          streamType: query.streamType
      - text: Show updates from stream {streamType} matching {filters}.
        slots:
          streamType: query.streamType
          filters: query.filters
      method: generated
      generated: '2026-09-26'