Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for PDF Services PDF Properties API

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

$.paths['/operation/pdfproperties/{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 PDF Properties API
  version: 1.0.0
extends: openapi/adobe-suite-pdf-properties-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/pdfproperties'].post
  update:
    x-apievangelist-phrasing:
      intent: Extract basic properties of a PDF
      effect: read
      questions:
      - How can I find out a PDF's page count and PDF version?
      - Can I tell whether a PDF is encrypted, linearized or has embedded files?
      instructions:
      - text: Get the page count and PDF version of this document.
      - text: Check whether this PDF is encrypted or contains embedded files.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/operation/pdfproperties/{jobID}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a PDF properties job
      effect: read
      questions:
      - Is my PDF properties extraction job done yet?
      - Where do I collect the results of a PDF properties job?
      instructions:
      - text: Check the status of PDF properties job {jobID}.
        slots:
          jobID: path.jobID
      - text: Poll properties job {jobID} until the results are ready.
        slots:
          jobID: path.jobID
      method: generated
      generated: '2026-09-26'