Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Real-time Customer Profile Profile System Jobs API

5 actions 5 updates phrasing extends openapi/adobe-suite-profile-system-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['/ups/system/jobs'].get

$.paths['/ups/system/jobs'].post

$.paths['/ups/system/jobs/{ID}'].get

$.paths['/ups/system/jobs/{ID}'].delete

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 Real-time Customer Profile Profile System Jobs API
  version: 1.0.0
extends: openapi/adobe-suite-profile-system-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['/ups/system/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List profile data delete requests
      effect: read
      questions:
      - What profile delete requests have been submitted in my sandbox?
      - Can I page and sort the list of profile system jobs?
      instructions:
      - text: List the latest {limit} profile delete requests.
        slots:
          limit: query.limit
      - text: Show profile system jobs sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ups/system/jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete all profile data for a dataset
      effect: destructive
      questions:
      - How do I wipe a dataset's data out of Real-Time Customer Profile?
      - Does a profile delete request remove all data in the dataset?
      instructions:
      - text: Create a delete request for dataset {dataSetId}.
        slots:
          dataSetId: requestBody.dataSetId
      - text: Remove all profile data from dataset {dataSetId}.
        slots:
          dataSetId: requestBody.dataSetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ups/system/jobs/{ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check one profile delete request
      effect: read
      questions:
      - Has my profile delete request completed?
      - Can I look up one profile system job by its ID?
      instructions:
      - text: Show delete request {ID}.
        slots:
          ID: path.ID
      - text: Get the status of profile system job {ID}.
        slots:
          ID: path.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ups/system/jobs/{ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a profile delete request record
      effect: destructive
      questions:
      - Can I remove a delete request from the profile system jobs list?
      - Is removing a profile system job supported on every cloud?
      instructions:
      - text: Remove delete request {ID}.
        slots:
          ID: path.ID
      - text: Clear profile system job {ID} from the job list.
        slots:
          ID: path.ID
      method: generated
      generated: '2026-09-26'