Adobe Suite · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Adobe Workfront Documentapproval API
11 actions
11 updates
phrasing
extends
openapi/adobe-suite-documentapproval-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.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/documentapproval/{id}'].get
$.paths['/documentapproval/{id}'].put
$.paths['/documentapproval/{id}'].delete
$.paths['/documentapproval'].get
$.paths['/documentapproval'].put
$.paths['/documentapproval'].post
$.paths['/documentapproval'].delete
$.paths['/documentapproval/count'].get
$.paths['/documentapproval/search'].get
$.paths['/documentapproval/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 Documentapproval API
version: 1.0.0
extends: openapi/adobe-suite-documentapproval-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['/documentapproval/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get one document approval
effect: read
questions:
- How do I look up a single document approval in Workfront by its ID?
- Can I choose which fields come back for one document approval?
instructions:
- text: Get document approval {id}.
slots:
id: path.id
- text: Fetch approval {id} with only the fields {fields}.
slots:
id: path.id
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/documentapproval/{id}'].put
update:
x-apievangelist-phrasing:
intent: Edit a document approval
effect: write
questions:
- Can I change the status or details of one document approval?
- What call updates a single document approval and returns chosen fields?
instructions:
- text: Edit document approval {id} with the changes I give you.
slots:
id: path.id
- text: Update approval {id} and return its {fields}.
slots:
id: path.id
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/documentapproval/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a document approval
effect: destructive
questions:
- How do I remove one approval request from a document?
- Is there a force flag for deleting a single document approval?
instructions:
- text: Delete document approval {id}.
slots:
id: path.id
- text: Force-delete approval {id} with force {force}.
slots:
id: path.id
force: query.force
method: generated
generated: '2026-09-26'
- target: $.paths['/documentapproval'].get
update:
x-apievangelist-phrasing:
intent: Get several document approvals by ID
effect: read
questions:
- Can I fetch a batch of document approvals if I have their IDs?
- What's the way to load multiple approvals together?
instructions:
- text: Get the document approvals with IDs {ids}.
slots:
ids: query.id
- text: Bulk-fetch approvals {ids} returning {fields}.
slots:
ids: query.id
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/documentapproval'].put
update:
x-apievangelist-phrasing:
intent: Edit many document approvals at once
effect: write
questions:
- Can I update a whole set of document approvals in one request?
- Is there a bulk edit for approvals rather than one at a time?
instructions:
- text: Bulk edit the document approvals I list with the changes I provide.
- text: Apply my edits to several approvals and return {fields}.
slots:
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/documentapproval'].post
update:
x-apievangelist-phrasing:
intent: Request approval on a document
effect: write
questions:
- How do I send a document to someone for approval?
- Can I create a document approval and pick which fields come back?
instructions:
- text: Create a document approval with the approver and document I give you.
- text: Add a new document approval and return its {fields}.
slots:
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/documentapproval'].delete
update:
x-apievangelist-phrasing:
intent: Delete several document approvals
effect: destructive
questions:
- Can I delete a batch of document approvals in one call?
- What happens when I force a bulk delete of approvals?
instructions:
- text: Delete the document approvals {ids}.
slots:
ids: query.id
- text: Bulk force-delete approvals {ids} with force {force}.
slots:
ids: query.id
force: query.force
method: generated
generated: '2026-09-26'
- target: $.paths['/documentapproval/count'].get
update:
x-apievangelist-phrasing:
intent: Count document approvals
effect: read
questions:
- How many document approvals are there?
- Can I count only the approvals that match a filter, such as pending ones?
instructions:
- text: Count all document approvals.
- text: Tell me how many approvals match {filters}.
slots:
filters: query.filters
method: generated
generated: '2026-09-26'
- target: $.paths['/documentapproval/search'].get
update:
x-apievangelist-phrasing:
intent: Search document approvals
effect: read
questions:
- How can I find document approvals meeting certain conditions?
- Can an approval search be sorted or paged?
instructions:
- text: Search document approvals matching {filters}.
slots:
filters: query.filters
- text: Find approvals where {filters}, returning {fields} with list options {listOptions}.
slots:
filters: query.filters
fields: query.fields
listOptions: query.listOptions
method: generated
generated: '2026-09-26'
- target: $.paths['/documentapproval/report'].get
update:
x-apievangelist-phrasing:
intent: Run a report on document approvals
effect: read
questions:
- Can I produce an aggregated report of document approvals?
- What report data can I pull on approvals filtered by conditions?
instructions:
- text: Run a document approval report filtered by {filters}.
slots:
filters: query.filters
- text: Build an approvals report with list options {listOptions}.
slots:
listOptions: query.listOptions
method: generated
generated: '2026-09-26'