Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for PDF Services Compress PDF API

3 actions 3 updates phrasing extends openapi/adobe-suite-compress-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/compresspdf'].post
$.paths['/operation/compresspdf/{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 Compress PDF API
  version: 1.0.0
extends: openapi/adobe-suite-compress-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/compresspdf'].post
  update:
    x-apievangelist-phrasing:
      intent: Compress a PDF to reduce its file size
      effect: write
      questions:
      - Can I shrink a large PDF before emailing it or sending it through a workflow?
      - What does PDF Services do to reduce a document's file size?
      instructions:
      - text: Compress my uploaded PDF to make it smaller.
      - text: Start a compress PDF job on the document I just uploaded.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/operation/compresspdf/{jobID}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a compress PDF job's status
      effect: read
      questions:
      - Is my PDF compression job finished yet?
      - Where do I find the compressed file once the job completes?
      instructions:
      - text: Check the status of compress PDF job {jobID}.
        slots:
          jobID: path.jobID
      - text: Poll compression job {jobID} until it's done.
        slots:
          jobID: path.jobID
      method: generated
      generated: '2026-09-26'