Adobe Suite · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Adobe Workfront Scorecard API
11 actions
11 updates
phrasing
extends
openapi/adobe-suite-scorecard-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['/scorecard/{id}'].get
$.paths['/scorecard/{id}'].put
$.paths['/scorecard/{id}'].delete
$.paths['/scorecard'].get
$.paths['/scorecard'].put
$.paths['/scorecard'].post
$.paths['/scorecard'].delete
$.paths['/scorecard/count'].get
$.paths['/scorecard/search'].get
$.paths['/scorecard/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 Scorecard API
version: 1.0.0
extends: openapi/adobe-suite-scorecard-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['/scorecard/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a scorecard by ID
effect: read
questions:
- What questions and weights are on a particular Workfront scorecard?
- Can I pick which fields come back for one scorecard?
instructions:
- text: Show me scorecard {id}.
slots:
id: path.id
- text: Get scorecard {id} with fields {fields}.
slots:
id: path.id
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/scorecard/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update a scorecard
effect: write
questions:
- How do I change the questions on an existing scorecard?
- Can I rename one scorecard used for project prioritization?
instructions:
- text: Update scorecard {id} with these changes.
slots:
id: path.id
- text: Edit scorecard {id} and return {fields}.
slots:
id: path.id
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/scorecard/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a scorecard
effect: destructive
questions:
- How do I remove a scorecard we no longer use?
- Is force needed to delete a scorecard already applied to projects?
instructions:
- text: Delete scorecard {id}.
slots:
id: path.id
- text: Force-delete scorecard {id} with force {force}.
slots:
id: path.id
force: query.force
method: generated
generated: '2026-09-26'
- target: $.paths['/scorecard'].get
update:
x-apievangelist-phrasing:
intent: Get several scorecards by their IDs
effect: read
questions:
- Can I load multiple scorecards in one request?
- What's the call for fetching scorecards from a list of IDs?
instructions:
- text: Get scorecards {id}.
slots:
id: query.id
- text: Load scorecards {id} together, including {fields}.
slots:
id: query.id
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/scorecard'].put
update:
x-apievangelist-phrasing:
intent: Bulk-update several scorecards
effect: write
questions:
- Can I edit many scorecards at once?
- Is there a bulk update for scorecards?
instructions:
- text: Apply these changes to all the scorecards I list in one bulk edit.
- text: Bulk-edit my scorecards and return {fields} for each.
slots:
fields: query.fields
method: generated
generated: '2026-09-26'
- target: $.paths['/scorecard'].post
update:
x-apievangelist-phrasing:
intent: Create or copy a scorecard
effect: write
questions:
- How do I create a new scorecard for scoring project requests?
- Can I start a scorecard by copying an existing one?
instructions:
- text: Create a new scorecard with these questions.
- text: Copy scorecard {copySourceID} into a new scorecard.
slots:
copySourceID: query.copySourceID
method: generated
generated: '2026-09-26'
- target: $.paths['/scorecard'].delete
update:
x-apievangelist-phrasing:
intent: Delete several scorecards at once
effect: destructive
questions:
- Can I delete a batch of scorecards together?
- What does the force option change on a bulk scorecard delete?
instructions:
- text: Delete scorecards {id} in bulk.
slots:
id: query.id
- text: Force-remove scorecards {id}, force {force}.
slots:
id: query.id
force: query.force
method: generated
generated: '2026-09-26'
- target: $.paths['/scorecard/count'].get
update:
x-apievangelist-phrasing:
intent: Count scorecards
effect: read
questions:
- How many scorecards exist in our instance?
- Can I count only scorecards that match a filter?
instructions:
- text: Count all scorecards.
- text: Count scorecards matching {filters}.
slots:
filters: query.filters
method: generated
generated: '2026-09-26'
- target: $.paths['/scorecard/search'].get
update:
x-apievangelist-phrasing:
intent: Search scorecards
effect: read
questions:
- How do I find a scorecard by its name?
- Can I sort and paginate scorecard search results?
instructions:
- text: Search scorecards where {filters}.
slots:
filters: query.filters
- text: Find scorecards matching {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['/scorecard/report'].get
update:
x-apievangelist-phrasing:
intent: Run a report over scorecards
effect: read
questions:
- Can I get grouped or aggregated figures across scorecards?
- Which call gives report output for scorecards?
instructions:
- text: Run a scorecard report for {filters}.
slots:
filters: query.filters
- text: Build a scorecards report with list options {listOptions}.
slots:
listOptions: query.listOptions
method: generated
generated: '2026-09-26'