Adobe Suite · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Adobe Workfront Parameteroption API
11 actions
11 updates
phrasing
extends
openapi/adobe-suite-parameteroption-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['/parameteroption/{id}'].get
$.paths['/parameteroption/{id}'].put
$.paths['/parameteroption/{id}'].delete
$.paths['/parameteroption'].get
$.paths['/parameteroption'].put
$.paths['/parameteroption'].post
$.paths['/parameteroption'].delete
$.paths['/parameteroption/count'].get
$.paths['/parameteroption/search'].get
$.paths['/parameteroption/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 Parameteroption API
version: 1.0.0
extends: openapi/adobe-suite-parameteroption-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['/parameteroption/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get one custom field option
effect: read
questions:
- How can I view a single choice defined for a Workfront custom field?
- Can I pick which fields come back for one parameter option?
instructions:
- text: Show parameter option {id}.
slots:
id: path.id
- text: Get parameter option {id} with fields {fields}.
slots:
id: path.id
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/parameteroption/{id}'].put
update:
x-apievangelist-phrasing:
intent: Edit a single custom field option
effect: write
questions:
- How do I rename or change one dropdown choice on a custom field?
- Can I update just one parameter option?
instructions:
- text: Update parameter option {id} with my changes.
slots:
id: path.id
- text: Edit parameter option {id} and return fields {fields}.
slots:
id: path.id
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/parameteroption/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete one custom field option
effect: destructive
questions:
- How do I remove a choice from a custom field?
- Can I force-delete a parameter option that is in use?
instructions:
- text: Delete parameter option {id}.
slots:
id: path.id
- text: Force delete parameter option {id} with force={force}.
slots:
id: path.id
force: query.force
method: generated
generated: '2026-09-26'
- target: $.paths['/parameteroption'].get
update:
x-apievangelist-phrasing:
intent: Fetch several custom field options by ID
effect: read
questions:
- Can I retrieve several parameter options in one call by ID?
- What does a bulk get of custom field options return?
instructions:
- text: Fetch parameter options {id} together.
slots:
id: query.id
- text: Bulk get parameter options {id} with fields {fields}.
slots:
id: query.id
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/parameteroption'].put
update:
x-apievangelist-phrasing:
intent: Edit many custom field options at once
effect: write
questions:
- Is there a way to update several custom field choices in one request?
- Can I bulk edit parameter options?
instructions:
- text: Bulk update these parameter options.
- text: Apply my edits to multiple parameter options and return {fields}.
slots:
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/parameteroption'].post
update:
x-apievangelist-phrasing:
intent: Create a custom field option
effect: write
questions:
- How do I add a new choice to a dropdown custom field?
- What gets created when I add a parameter option?
instructions:
- text: Create a new parameter option.
- text: Add a custom field option and return fields {fields}.
slots:
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/parameteroption'].delete
update:
x-apievangelist-phrasing:
intent: Delete several custom field options at once
effect: destructive
questions:
- Can I delete multiple custom field choices in one call?
- Is there a bulk removal for parameter options?
instructions:
- text: Delete parameter options {id} in bulk.
slots:
id: query.id
- text: Bulk delete parameter options {id} with force={force}.
slots:
id: query.id
force: query.force
method: generated
generated: '2026-09-26'
- target: $.paths['/parameteroption/count'].get
update:
x-apievangelist-phrasing:
intent: Count custom field options
effect: read
questions:
- How many parameter options are defined?
- Can I count only the custom field options matching a filter?
instructions:
- text: Count the parameter options.
- text: Count parameter options where {filters}.
slots:
filters: query.filters
method: generated
generated: '2026-09-26'
- target: $.paths['/parameteroption/search'].get
update:
x-apievangelist-phrasing:
intent: Search custom field options
effect: read
questions:
- How do I find custom field options by label or value?
- Can I page through parameter option search results?
instructions:
- text: Search parameter options matching {filters}.
slots:
filters: query.filters
- text: Find parameter options matching {filters} and return {fields}.
slots:
filters: query.filters
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/parameteroption/report'].get
update:
x-apievangelist-phrasing:
intent: Run an aggregate report on custom field options
effect: read
questions:
- Can I get grouped report data about parameter options?
- What summary can I build across custom field options?
instructions:
- text: Run a parameter option report filtered by {filters}.
slots:
filters: query.filters
- text: Report on parameter options using list options {listOptions}.
slots:
listOptions: query.listOptions
method: generated
generated: '2026-09-26'