Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Proofaction API

7 actions 7 updates phrasing extends openapi/adobe-suite-proofaction-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 7

$.info
$.paths['/proofaction/{id}'].get
$.paths['/proofaction'].get
$.paths['/proofaction'].post
$.paths['/proofaction/count'].get
$.paths['/proofaction/search'].get
$.paths['/proofaction/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 Proofaction API
  version: 1.0.0
extends: openapi/adobe-suite-proofaction-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: 6
- target: $.paths['/proofaction/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one proof action
      effect: read
      questions:
      - How do I look up a single Workfront proof action by its ID?
      - Can I choose which fields come back for one proof action?
      instructions:
      - text: Get proof action {id}.
        slots:
          id: path.id
      - text: Fetch proof action {id} with only the fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/proofaction'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several proof actions by ID
      effect: read
      questions:
      - Can I fetch a batch of proof actions when I have their IDs?
      - What's the way to load multiple proof actions together?
      instructions:
      - text: Get the proof actions with IDs {ids}.
        slots:
          ids: query.id
      - text: Bulk-fetch proof actions {ids} returning {fields}.
        slots:
          ids: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/proofaction'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a proof action
      effect: write
      questions:
      - How do I record a new action taken on a proof?
      - Can I create a proof action and pick which fields are returned?
      instructions:
      - text: Create a proof action with the details I give you.
      - text: Add a proof action and return its {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/proofaction/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count proof actions
      effect: read
      questions:
      - How many proof actions have been recorded?
      - Can I count only the proof actions that match a filter?
      instructions:
      - text: Count all proof actions.
      - text: Tell me how many proof actions match {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/proofaction/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search proof actions
      effect: read
      questions:
      - What proof actions meet certain conditions?
      - Can a proof action search be sorted or paged?
      instructions:
      - text: Search proof actions matching {filters}.
        slots:
          filters: query.filters
      - text: Find proof actions 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['/proofaction/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report on proof actions
      effect: read
      questions:
      - Can I produce an aggregated report of proof actions?
      - What report data is available on proof actions filtered by conditions?
      instructions:
      - text: Run a proof action report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Build a proof actions report with list options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'