Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for PDF Services Document Generation API

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

$.info

$.paths['/operation/documentgeneration'].post

$.paths['/operation/documentgeneration/{jobID}/status'].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 PDF Services Document Generation API
  version: 1.0.0
extends: openapi/adobe-suite-document-generation-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: 2
- target: $.paths['/operation/documentgeneration'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate documents from a Word template
      effect: write
      questions:
      - How do I merge JSON data into a Word template to produce a PDF?
      - Can I generate both Word and PDF documents from the same template?
      instructions:
      - text: Merge my JSON data into the Word template and produce a PDF.
      - text: Generate a Word document from my template using the data I provide.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/operation/documentgeneration/{jobID}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a document generation job
      effect: read
      questions:
      - Is my document generation job finished yet?
      - How can I tell when a merged document is ready to download?
      instructions:
      - text: Check the status of document generation job {jobID}.
        slots:
          jobID: path.jobID
      - text: Poll job {jobID} until the generated document is ready.
        slots:
          jobID: path.jobID
      method: generated
      generated: '2026-09-26'