Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for PDF Services Html to PDF API

3 actions 3 updates phrasing extends openapi/adobe-suite-html-to-pdf-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/htmltopdf'].post

$.paths['/operation/htmltopdf/{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 Html to PDF API
  version: 1.0.0
extends: openapi/adobe-suite-html-to-pdf-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/htmltopdf'].post
  update:
    x-apievangelist-phrasing:
      intent: Convert HTML or a web page into a PDF
      effect: write
      questions:
      - How do I turn an HTML page with inline CSS into a PDF with Adobe PDF Services?
      - Can I generate a PDF from a URL instead of uploading HTML?
      - Can dynamic HTML be filled with JSON data before it's rendered to PDF?
      instructions:
      - text: Convert my HTML file into a PDF.
      - text: Create a PDF from this web page using client ID {x-api-key}.
        slots:
          x-api-key: header.x-api-key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/operation/htmltopdf/{jobID}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether an HTML-to-PDF job is done
      effect: read
      questions:
      - How do I know when my HTML to PDF conversion has finished?
      - Where do I get the result once the HTML to PDF job completes?
      instructions:
      - text: Check the status of HTML to PDF job {jobID}.
        slots:
          jobID: path.jobID
      - text: Poll job {jobID} until the PDF is ready.
        slots:
          jobID: path.jobID
      method: generated
      generated: '2026-09-26'