Adobe Suite · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Adobe Workfront Role API
12 actions
12 updates
phrasing
extends
openapi/adobe-suite-role-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 12
$.info
$.paths['/role/{id}'].get
$.paths['/role/{id}'].put
$.paths['/role/{id}'].delete
$.paths['/role'].get
$.paths['/role'].put
$.paths['/role'].post
$.paths['/role'].delete
$.paths['/role/replace'].put
$.paths['/role/count'].get
$.paths['/role/search'].get
$.paths['/role/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 Role API
version: 1.0.0
extends: openapi/adobe-suite-role-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: 11
- target: $.paths['/role/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get one Workfront job role
effect: read
questions:
- How do I look up a single job role by its ID?
- Can I fetch just the billing rate fields of one role?
instructions:
- text: Show me job role {id}.
slots:
id: path.id
- text: Get the {fields} of role {id}.
slots:
fields: query.fields
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/role/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update one job role
effect: write
questions:
- Can I rename or change the rates on an existing job role?
- What edits a single Workfront role in place?
instructions:
- text: Edit job role {id} with my changes.
slots:
id: path.id
- text: Update role {id} and return {fields}.
slots:
id: path.id
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/role/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete one job role
effect: destructive
questions:
- How do I remove a single job role?
- Is there a force flag for deleting a role still assigned to people?
instructions:
- text: Delete job role {id}.
slots:
id: path.id
- text: Force-delete role {id} with force {force}.
slots:
id: path.id
force: query.force
method: generated
generated: '2026-09-26'
- target: $.paths['/role'].get
update:
x-apievangelist-phrasing:
intent: Get several job roles by ID
effect: read
questions:
- Can I load multiple job roles at once from their IDs?
- What returns a batch of roles I already have IDs for?
instructions:
- text: Fetch job roles {id}.
slots:
id: query.id
- text: Bulk-load roles {id} with only {fields}.
slots:
id: query.id
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/role'].put
update:
x-apievangelist-phrasing:
intent: Update many job roles at once
effect: write
questions:
- Can I change several job roles in one request?
- Which call bulk-updates Workfront roles together?
instructions:
- text: Bulk-edit the job roles in my payload.
- text: Apply these edits to several roles and return {fields}.
slots:
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/role'].post
update:
x-apievangelist-phrasing:
intent: Create a job role
effect: write
questions:
- How do I add a new job role such as Designer or Developer?
- What creates a role that resources can then be assigned to?
instructions:
- text: Create a new job role from my definition.
- text: Add a role and give me back its {fields}.
slots:
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/role'].delete
update:
x-apievangelist-phrasing:
intent: Delete several job roles
effect: destructive
questions:
- Can I remove multiple job roles in one call?
- What bulk-deletes roles by a list of IDs?
instructions:
- text: Delete job roles {id}.
slots:
id: query.id
- text: Bulk force-delete roles {id} with force {force}.
slots:
id: query.id
force: query.force
method: generated
generated: '2026-09-26'
- target: $.paths['/role/replace'].put
update:
x-apievangelist-phrasing:
intent: Replace job roles with another role
effect: write
questions:
- How do I merge old job roles into one replacement role?
- Can I reassign everything that uses some roles to a different role?
instructions:
- text: Replace roles {id} with role {replacementID}.
slots:
id: query.id
replacementID: query.replacementID
- text: Move all assignments on job roles {id} to {replacementID}.
slots:
id: query.id
replacementID: query.replacementID
method: generated
generated: '2026-09-26'
- target: $.paths['/role/count'].get
update:
x-apievangelist-phrasing:
intent: Count job roles
effect: read
questions:
- How many job roles are set up in Workfront?
- Can I count only the roles that match a filter?
instructions:
- text: Count all job roles.
- text: Tell me how many roles match {filters}.
slots:
filters: query.filters
method: generated
generated: '2026-09-26'
- target: $.paths['/role/search'].get
update:
x-apievangelist-phrasing:
intent: Search job roles
effect: read
questions:
- How do I find job roles by name or active status?
- Can I sort and page through role search results?
instructions:
- text: Search job roles matching {filters}.
slots:
filters: query.filters
- text: Find roles where {filters} using list options {listOptions}.
slots:
filters: query.filters
listOptions: query.listOptions
method: generated
generated: '2026-09-26'
- target: $.paths['/role/report'].get
update:
x-apievangelist-phrasing:
intent: Run an aggregate report over job roles
effect: read
questions:
- Can I get grouped totals across job roles?
- What produces an aggregated summary of roles instead of individual records?
instructions:
- text: Summarize job roles grouped by {listOptions}.
slots:
listOptions: query.listOptions
- text: Produce aggregate role totals for {filters}.
slots:
filters: query.filters
method: generated
generated: '2026-09-26'