Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Segmentation Service Export jobs API

5 actions 5 updates phrasing extends openapi/adobe-suite-export-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['/export/jobs'].get
$.paths['/export/jobs'].post
$.paths['/export/jobs/{EXPORT_JOB_ID}'].get
$.paths['/export/jobs/{EXPORT_JOB_ID}'].delete

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 Segmentation Service Export jobs API
  version: 1.0.0
extends: openapi/adobe-suite-export-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['/export/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List profile export jobs
      effect: read
      questions:
      - What audience export jobs have run in my sandbox?
      - Can I list only export jobs that failed or are still processing?
      instructions:
      - text: List export jobs in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show the last {limit} export jobs with status {status}.
        slots:
          limit: query.limit
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/export/jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Export profiles to a dataset
      effect: write
      questions:
      - How do I export the profiles in a segment to a dataset?
      - Can I choose which profile fields and merge policy an export uses?
      instructions:
      - text: Export profiles matching {filter} to {destination}.
        slots:
          filter: requestBody.filter
          destination: requestBody.destination
      - text: Start a profile export of fields {fields} using merge policy {mergePolicy} into {destination}.
        slots:
          fields: requestBody.fields
          mergePolicy: requestBody.mergePolicy
          destination: requestBody.destination
      method: generated
      generated: '2026-09-26'
- target: $.paths['/export/jobs/{EXPORT_JOB_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one export job's status
      effect: read
      questions:
      - Is my profile export job finished yet?
      - How do I check the details and metrics of a single export job?
      instructions:
      - text: Show export job {EXPORT_JOB_ID}.
        slots:
          EXPORT_JOB_ID: path.EXPORT_JOB_ID
      - text: Check the progress of profile export {EXPORT_JOB_ID}.
        slots:
          EXPORT_JOB_ID: path.EXPORT_JOB_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/export/jobs/{EXPORT_JOB_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel or delete an export job
      effect: destructive
      questions:
      - Can I stop a profile export that is still running?
      - How do I get rid of an export job I no longer want?
      instructions:
      - text: Cancel export job {EXPORT_JOB_ID}.
        slots:
          EXPORT_JOB_ID: path.EXPORT_JOB_ID
      - text: Delete the profile export {EXPORT_JOB_ID}.
        slots:
          EXPORT_JOB_ID: path.EXPORT_JOB_ID
      method: generated
      generated: '2026-09-26'