Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Privacy Service Privacy jobs API

5 actions 5 updates phrasing extends openapi/adobe-suite-privacy-jobs-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 5

$.info
$.paths['/jobs'].get
$.paths['/jobs'].post
$.paths['/jobs/{JOB_ID}'].get
$.paths['/jobs/{JOB_ID}/content'].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 Privacy Service Privacy jobs API
  version: 1.0.0
extends: openapi/adobe-suite-privacy-jobs-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: 4
- target: $.paths['/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List privacy jobs for a regulation
      effect: read
      questions:
      - Which GDPR or CCPA privacy requests have we submitted?
      - Can I filter privacy jobs by processing status or date range?
      instructions:
      - text: List privacy jobs under regulation {regulation}.
        slots:
          regulation: query.regulation
      - text: Show {regulation} privacy jobs with status {status} processed after {fromDate}.
        slots:
          regulation: query.regulation
          status: query.status
          fromDate: query.fromDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a privacy access or delete request
      effect: write
      questions:
      - How do I submit a customer's data access or deletion request?
      - Which Adobe products can a single privacy job cover?
      instructions:
      - text: Create a {regulation} privacy job for users {users} across products {include}.
        slots:
          regulation: requestBody.regulation
          users: requestBody.users
          include: requestBody.include
      - text: Submit a privacy request for {users} in {include} with company contexts {companyContexts}.
        slots:
          users: requestBody.users
          include: requestBody.include
          companyContexts: requestBody.companyContexts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{JOB_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a privacy job's status
      effect: read
      questions:
      - Has a specific privacy request finished processing?
      - Can I check one privacy job by its job ID?
      instructions:
      - text: Show privacy job {jobId}.
        slots:
          jobId: path.JOB_ID
      - text: Check the processing status of privacy job {jobId}.
        slots:
          jobId: path.JOB_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/jobs/{JOB_ID}/content'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a customer's access request data
      effect: read
      questions:
      - Where do I download the data gathered for a customer's access request?
      - Can I securely retrieve the results of a completed access job?
      instructions:
      - text: Download the customer data for privacy job {jobId}.
        slots:
          jobId: path.JOB_ID
      - text: Retrieve the access request content produced by job {jobId}.
        slots:
          jobId: path.JOB_ID
      method: generated
      generated: '2026-09-26'