Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Unified Approvals API (Deprecated) Public API

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

$.info
$.paths['/public/api/v1/approvals/{assetType}/{assetId}'].get
$.paths['/public/api/v1/approvals/{assetType}/{assetId}/stages'].put
$.paths['/public/api/v1/approvals/{assetType}/{assetId}/decisions'].put
$.paths['/public/api/v1/approvals/{assetType}/{assetId}/participants'].put
$.paths['/public/api/v1/approvals/{assetType}/{assetId}/participants'].delete
$.paths['/public/api/v1/approvals/{assetType}/{assetId}/stages/{stageId}/lock'].put
$.paths['/public/api/v1/approvals/{assetType}/{assetId}/stages/{stageId}/unlock'].put

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 Unified Approvals API (Deprecated) Public API
  version: 1.0.0
extends: openapi/adobe-suite-public-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: 7
- target: $.paths['/public/api/v1/approvals/{assetType}/{assetId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the approval for an asset
      effect: read
      questions:
      - What approval is required on a given Workfront asset?
      - Can I see the stages and participants of an asset's approval?
      instructions:
      - text: Get the approval for {assetType} {assetId} (asset type {AssetType}).
        slots:
          assetType: path.assetType
          AssetType: path.AssetType
          assetId: path.assetId
      - text: Show the approval status of asset {assetId}.
        slots:
          assetId: path.assetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/api/v1/approvals/{assetType}/{assetId}/stages'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update an asset approval
      effect: write
      questions:
      - How do I start an approval on an asset with a single stage?
      - Can I update an approval that already exists instead of creating a new one?
      instructions:
      - text: Create an approval on {assetType} {assetId} (asset type {AssetType}) with stages {stages}.
        slots:
          assetType: path.assetType
          AssetType: path.AssetType
          assetId: path.assetId
          stages: requestBody.stages
      - text: Set up a single-stage approval for asset {assetId}.
        slots:
          assetId: path.assetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/api/v1/approvals/{assetType}/{assetId}/decisions'].put
  update:
    x-apievangelist-phrasing:
      intent: Approve or reject an asset
      effect: write
      questions:
      - How do I record my approve or reject decision on an asset's approval stage?
      - Can I change a decision I already made on an approval?
      instructions:
      - text: Record decision {decision} on {assetType} {assetId} (asset type {AssetType}).
        slots:
          assetType: path.assetType
          AssetType: path.AssetType
          assetId: path.assetId
          decision: requestBody.decision
      - text: Approve asset {assetId} with decision {decision}.
        slots:
          assetId: path.assetId
          decision: requestBody.decision
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/api/v1/approvals/{assetType}/{assetId}/participants'].put
  update:
    x-apievangelist-phrasing:
      intent: Add approvers to an asset approval
      effect: write
      questions:
      - How do I add reviewers to an existing approval?
      - Can I change an approval participant's role by adding them again?
      instructions:
      - text: Add participants to the approval on {assetType} {assetId} (asset type {AssetType}).
        slots:
          assetType: path.assetType
          AssetType: path.AssetType
          assetId: path.assetId
      - text: Update the participant roles on asset {assetId}'s approval.
        slots:
          assetId: path.assetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/api/v1/approvals/{assetType}/{assetId}/participants'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove approvers from an asset approval
      effect: destructive
      questions:
      - How do I take someone off an approval as a reviewer?
      - What happens if I remove the last participant from an approval?
      instructions:
      - text: Remove participants {participants} from the approval on {assetType} {assetId} (asset type {AssetType}).
        slots:
          assetType: path.assetType
          AssetType: path.AssetType
          assetId: path.assetId
          participants: requestBody.participants
      - text: Take participants off stage {stageId} of asset {assetId}'s approval.
        slots:
          stageId: requestBody.stageId
          assetId: path.assetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/api/v1/approvals/{assetType}/{assetId}/stages/{stageId}/lock'].put
  update:
    x-apievangelist-phrasing:
      intent: Lock an approval stage
      effect: write
      questions:
      - How do I freeze an approval stage so nobody can make further decisions?
      - Can I stop participants from being added or removed on a stage?
      instructions:
      - text: Lock stage {stageId} of the approval on {assetType} {assetId} (asset type {AssetType}).
        slots:
          assetType: path.assetType
          AssetType: path.AssetType
          assetId: path.assetId
          stageId: path.stageId
      - text: Freeze approval stage {stageId} on asset {assetId}.
        slots:
          stageId: path.stageId
          assetId: path.assetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/api/v1/approvals/{assetType}/{assetId}/stages/{stageId}/unlock'].put
  update:
    x-apievangelist-phrasing:
      intent: Unlock an approval stage
      effect: write
      questions:
      - How do I reopen a locked approval stage for decisions?
      - Can participants be changed again after I unlock a stage?
      instructions:
      - text: Unlock stage {stageId} of the approval on {assetType} {assetId} (asset type {AssetType}).
        slots:
          assetType: path.assetType
          AssetType: path.AssetType
          assetId: path.assetId
          stageId: path.stageId
      - text: Reopen locked approval stage {stageId} on asset {assetId}.
        slots:
          stageId: path.stageId
          assetId: path.assetId
      method: generated
      generated: '2026-10-01'