Adobe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Document Generation API

3 actions 3 updates phrasing extends openapi/adobe-document-generation-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Adobe's API. It is a proposal applied on top of the contract, not a document Adobe 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 Adobe Document Generation API
  version: 1.0.0
extends: openapi/adobe-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 and JSON
      effect: write
      questions:
      - How do I fill a Word template with JSON data to produce contracts or invoices?
      - Can document generation output both a Word file and a PDF?
      instructions:
      - text: Merge this JSON data into my Word template and output a PDF.
      - text: Generate a Word document from my template using this customer data.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/operation/documentgeneration/{jobID}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a document generation job
      effect: read
      questions:
      - Is my templated document ready yet?
      - Where do I download the generated document after the merge job finishes?
      instructions:
      - text: Check document generation job {jobID}.
        slots:
          jobID: path.jobID
      - text: Poll template merge job {jobID} and return the generated document.
        slots:
          jobID: path.jobID
      method: generated
      generated: '2026-09-26'