Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for PDF Services Protect PDF API

3 actions 3 updates phrasing extends openapi/adobe-suite-protect-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/protectpdf'].post
$.paths['/operation/protectpdf/{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 Protect PDF API
  version: 1.0.0
extends: openapi/adobe-suite-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 and restrict a PDF
      effect: write
      questions:
      - How do I put a password on a PDF with Adobe PDF Services?
      - Can I stop people from printing, editing or copying from a PDF?
      instructions:
      - text: Encrypt my PDF with a user password so it needs one to open.
      - text: Protect this PDF with an owner password and block printing and copying.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/operation/protectpdf/{jobID}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a protect-PDF job's status
      effect: read
      questions:
      - Is my PDF protection job finished yet?
      - How do I poll for the encrypted PDF once the protect job completes?
      instructions:
      - text: Check the status of protect PDF job {jobID}.
        slots:
          jobID: path.jobID
      - text: Poll job {jobID} until the protected PDF is ready.
        slots:
          jobID: path.jobID
      method: generated
      generated: '2026-09-26'