Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Awaitingapproval API

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

$.info
$.paths['/awaitingapproval/{id}'].get
$.paths['/awaitingapproval/{id}'].delete
$.paths['/awaitingapproval'].get
$.paths['/awaitingapproval'].post
$.paths['/awaitingapproval'].delete
$.paths['/awaitingapproval/count'].get
$.paths['/awaitingapproval/search'].get
$.paths['/awaitingapproval/report'].get
$.paths['/awaitingapproval/getMyAwaitingApprovalsFilteredCount'].put
$.paths['/awaitingapproval/myAwaitingApprovalsFiltered'].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 Awaitingapproval API
  version: 1.0.0
extends: openapi/adobe-suite-awaitingapproval-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: 10
- target: $.paths['/awaitingapproval/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one pending approval
      effect: read
      questions:
      - How do I see the details of one item waiting for approval in Workfront?
      - Can I choose which fields come back for a single pending approval?
      instructions:
      - text: Show awaiting approval {id}.
        slots:
          id: path.id
      - text: Get pending approval {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/awaitingapproval/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one pending approval record
      effect: destructive
      questions:
      - Can I remove a single awaiting-approval record?
      - Is there a force option when deleting one pending approval?
      instructions:
      - text: Delete awaiting approval {id}.
        slots:
          id: path.id
      - text: Remove pending approval {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/awaitingapproval'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several pending approvals by ID
      effect: read
      questions:
      - Can I load a batch of awaiting approvals when I have their IDs?
      - Which call returns multiple known pending approvals together?
      instructions:
      - text: Fetch awaiting approvals {id}.
        slots:
          id: query.id
      - text: Get pending approvals {id} showing only {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/awaitingapproval'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an awaiting-approval record
      effect: write
      questions:
      - What do I send to create a new awaiting-approval record?
      - Can I add an item to the approval queue through the API?
      instructions:
      - text: Create an awaiting approval with the details I provide.
      - text: Add a pending approval record and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/awaitingapproval'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete many pending approval records
      effect: destructive
      questions:
      - Can I bulk delete awaiting approvals by listing their IDs?
      - What clears several pending approval records in one call?
      instructions:
      - text: Bulk delete awaiting approvals {id}.
        slots:
          id: query.id
      - text: Remove every pending approval in {id} using force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/awaitingapproval/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count pending approvals
      effect: read
      questions:
      - How many items are awaiting approval across the system for a filter?
      - Can I get the total of awaiting approvals matching certain conditions?
      instructions:
      - text: Count awaiting approvals where {filters}.
        slots:
          filters: query.filters
      - text: Tell me how many approvals are pending overall.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/awaitingapproval/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search pending approvals
      effect: read
      questions:
      - How do I find approvals waiting on a particular approver or object?
      - Can I search awaiting approvals with paging and sort options?
      instructions:
      - text: Search awaiting approvals matching {filters}.
        slots:
          filters: query.filters
      - text: Find pending approvals where {filters} and list {fields}.
        slots:
          filters: query.filters
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/awaitingapproval/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an aggregate report on pending approvals
      effect: read
      questions:
      - Can I get grouped totals of pending approvals as a report?
      - Which call gives a report-style summary of awaiting approvals?
      instructions:
      - text: Run an awaiting approvals report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Summarize pending approvals as a report with {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/awaitingapproval/getMyAwaitingApprovalsFilteredCount'].put
  update:
    x-apievangelist-phrasing:
      intent: Count my own pending approvals by object type
      effect: read
      questions:
      - How many approvals are waiting on me personally?
      - Can I count just my pending approvals for one object type, like documents?
      instructions:
      - text: Count the {objectType} approvals waiting on me.
        slots:
          objectType: query.objectType
      - text: Give me the number of items in my approval inbox.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/awaitingapproval/myAwaitingApprovalsFiltered'].get
  update:
    x-apievangelist-phrasing:
      intent: List my own pending approvals by object type
      effect: read
      questions:
      - What is currently waiting for my approval?
      - Can I list only my pending approvals for a specific object type?
      instructions:
      - text: List the {objectType} items waiting for my approval.
        slots:
          objectType: query.objectType
      - text: Show everything in my approval inbox.
      method: generated
      generated: '2026-09-26'