Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Approvalprocess API

11 actions 11 updates phrasing extends openapi/adobe-suite-approval-process-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['/approvalprocess/{id}'].get
$.paths['/approvalprocess/{id}'].put
$.paths['/approvalprocess/{id}'].delete
$.paths['/approvalprocess'].get
$.paths['/approvalprocess'].put
$.paths['/approvalprocess'].post
$.paths['/approvalprocess'].delete
$.paths['/approvalprocess/count'].get
$.paths['/approvalprocess/search'].get
$.paths['/approvalprocess/report'].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 Approvalprocess API
  version: 1.0.0
extends: openapi/adobe-suite-approval-process-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/approvalprocess/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one approval process
      effect: read
      questions:
      - How do I view a single approval process and its setup?
      - Can I choose which fields come back for one approval process?
      instructions:
      - text: Show approval process {id}.
        slots:
          id: path.id
      - text: Get approval process {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/approvalprocess/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an approval process
      effect: write
      questions:
      - Can I change the stages or approvers of an existing approval process?
      - What call edits one approval process by ID?
      instructions:
      - text: Edit approval process {id} with my changes.
        slots:
          id: path.id
      - text: Update approval process {id} and return {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/approvalprocess/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an approval process
      effect: destructive
      questions:
      - How do I remove an approval process we no longer use?
      - Is there a force option when deleting an approval process?
      instructions:
      - text: Delete approval process {id}.
        slots:
          id: path.id
      - text: Force-delete approval process {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-10-01'
- target: $.paths['/approvalprocess'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several approval processes by ID
      effect: read
      questions:
      - Can I load multiple approval processes at once by their IDs?
      - Which call returns a batch of known approval processes?
      instructions:
      - text: Fetch approval processes {id}.
        slots:
          id: query.id
      - text: Get approval processes {id} showing only {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/approvalprocess'].put
  update:
    x-apievangelist-phrasing:
      intent: Update many approval processes at once
      effect: write
      questions:
      - Is there a bulk edit for approval processes?
      - Can I apply the same change to a set of approval processes?
      instructions:
      - text: Bulk edit these approval processes with my changes.
      - text: Update several approval processes and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/approvalprocess'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or copy an approval process
      effect: write
      questions:
      - How do I set up a new approval process?
      - Can I create an approval process by copying an existing one?
      instructions:
      - text: Create a new approval process.
      - text: Copy approval process {copySourceID} into a new one.
        slots:
          copySourceID: query.copySourceID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/approvalprocess'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete many approval processes
      effect: destructive
      questions:
      - Can I delete a list of approval processes in one request?
      - What happens when I bulk delete approval processes with force?
      instructions:
      - text: Delete approval processes {id}.
        slots:
          id: query.id
      - text: Bulk delete approval processes {id} with force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-10-01'
- target: $.paths['/approvalprocess/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count approval processes
      effect: read
      questions:
      - How many approval processes are configured?
      - Can I count only the approval processes that match a filter?
      instructions:
      - text: Count all approval processes.
      - text: Count approval processes matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/approvalprocess/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search approval processes
      effect: read
      questions:
      - Which approval processes match certain criteria?
      - Can I search approval processes and page the results?
      instructions:
      - text: Search approval processes where {filters}.
        slots:
          filters: query.filters
      - text: Find approval processes matching {filters} returning {fields}.
        slots:
          filters: query.filters
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/approvalprocess/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an approval process report
      effect: read
      questions:
      - Can I get an aggregated report across approval processes?
      - What grouped totals does an approval process report return?
      instructions:
      - text: Run an approval process report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Build an approval process report with list options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-10-01'