Adobe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Protect PDF API

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

$.paths['/operation/protectpdf/{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 Protect PDF API
  version: 1.0.0
extends: openapi/adobe-protect-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/protectpdf'].post
  update:
    x-apievangelist-phrasing:
      intent: Password-protect a PDF and restrict permissions
      effect: write
      questions:
      - How do I password-protect a PDF?
      - Can I stop people from printing, editing or copying a PDF?
      - Which encryption algorithm can I choose when securing a PDF?
      instructions:
      - text: Protect this PDF with a password.
      - text: Encrypt my PDF with AES-256 and block printing and copying.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/operation/protectpdf/{jobID}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a PDF protection job
      effect: read
      questions:
      - Is my password-protected PDF ready?
      - Has the encryption job for my PDF completed?
      instructions:
      - text: Check protect PDF job {jobID}.
        slots:
          jobID: path.jobID
      - text: Poll encryption job {jobID} and return the secured PDF.
        slots:
          jobID: path.jobID
      method: generated
      generated: '2026-09-26'