Adobe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for PDF Services Import PDF Form Data API

3 actions 3 updates phrasing extends openapi/adobe-import-pdf-form-data-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/setformdata'].post
$.paths['/operation/setformdata/{jobID}/status'].get

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 PDF Services Import PDF Form Data API
  version: 1.0.0
extends: openapi/adobe-import-pdf-form-data-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/setformdata'].post
  update:
    x-apievangelist-phrasing:
      intent: Fill a PDF form from JSON data
      effect: write
      questions:
      - Can I fill in a PDF form automatically from JSON?
      - What format does the data need to be in to populate a PDF form's fields?
      instructions:
      - text: Fill this PDF form with the values in my JSON.
      - text: Populate the form fields of this PDF from our customer record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/operation/setformdata/{jobID}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a form fill job
      effect: read
      questions:
      - Is my filled-in PDF form ready?
      - How do I get the populated PDF after importing form data?
      instructions:
      - text: Check form fill job {jobID}.
        slots:
          jobID: path.jobID
      - text: Poll set-form-data job {jobID} and return the filled PDF.
        slots:
          jobID: path.jobID
      method: generated
      generated: '2026-09-26'