Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Suite Manage jobs API

7 actions 7 updates phrasing extends openapi/adobe-suite-manage-jobs-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['/v1/status/{jobId}'].get
$.paths['/v1/cancel/{jobId}'].put
$.paths['/v1/templates/render-jobs'].get
$.paths['/v2/status/{jobId}'].get
$.paths['/v3/status/{jobId}'].get
$.paths['/v3/cancel/{jobId}'].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 Adobe Suite Manage jobs API
  version: 1.0.0
extends: openapi/adobe-suite-manage-jobs-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['/v1/status/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a v1 async job status
      effect: read
      questions:
      - How do I check whether a Dynamic Graphics Render or Describe job finished?
      - Where do I get the result of a v1 asynchronous job?
      instructions:
      - text: Get the v1 status of job {jobId}.
        slots:
          jobId: path.jobId
      - text: Check if the template render or describe job {jobId} is done.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/cancel/{jobId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Cancel a template render job
      effect: destructive
      questions:
      - Can I abort a template render job that is still running?
      - What status does a render job report after I cancel it?
      instructions:
      - text: Cancel render job {jobId}.
        slots:
          jobId: path.jobId
      - text: Abort the in-flight template render {jobId} with request ID {request_id}.
        slots:
          jobId: path.jobId
          request_id: header.x-request-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/templates/render-jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List my template render jobs
      effect: read
      questions:
      - Which template render jobs have I submitted?
      - Can I filter render jobs by status or creation date?
      - What is the maximum page size when listing render jobs?
      instructions:
      - text: List my template render jobs.
      - text: List render jobs matching filter {filter}.
        slots:
          filter: query.filter
      - text: Show the next {limit} render jobs after cursor {cursor}.
        slots:
          limit: query.limit
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/status/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a reframed video job result
      effect: read
      questions:
      - How do I get the output of a video reframe job?
      - Where is the result of a v2 reframing job?
      instructions:
      - text: Get the reframe result for job {jobId}.
        slots:
          jobId: path.jobId
      - text: Fetch the reframed video output of job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a v3 generation or upscale job
      effect: read
      questions:
      - How do I check an upscale or composite job's status?
      - Can I poll a v3 generation job by its URN?
      instructions:
      - text: Get the v3 status of job {jobId}.
        slots:
          jobId: path.jobId
      - text: Check whether upscale job {jobId} has completed.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/cancel/{jobId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Cancel a v3 asynchronous job
      effect: destructive
      questions:
      - Can I cancel a generation or upscale job I started?
      - How do I stop a v3 async job by its URN?
      instructions:
      - text: Cancel v3 job {jobId}.
        slots:
          jobId: path.jobId
      - text: Stop the asynchronous generation job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'