# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Suite Batches API
  version: 1.0.0
extends: openapi/adobe-suite-batches-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: 12
- target: $.paths['/batches'].get
  update:
    x-apievangelist-phrasing:
      intent: List ingestion batches in the catalog
      effect: read
      questions:
      - How do I list the data batches tracked by the Experience Platform catalog?
      - Can I see only batches that failed or had records that couldn't be processed?
      - Which batches were loaded into a given dataset last week?
      instructions:
      - text: List batches for dataset {dataSet}.
        slots:
          dataSet: query.dataSet
      - text: Show catalog batches with status {status} created after {createdAfter}.
        slots:
          status: query.status
          createdAfter: query.createdAfter
      - text: List the latest {limit} catalog batches sorted by {orderBy}.
        slots:
          limit: query.limit
          orderBy: query.orderBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new catalog batch
      effect: write
      questions:
      - How do I register a new batch in the catalog to track an ingestion?
      - What status must I give a batch when I create it?
      instructions:
      - text: Create a catalog batch with status {status}.
        slots:
          status: requestBody.status
      - text: Create a batch with status {status} and external ID {externalId}.
        slots:
          status: requestBody.status
          externalId: requestBody.externalId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches/uniques/{FIELD}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up distinct values of a batch field
      effect: read
      questions:
      - How can I see every distinct value stored in one field across my batches?
      - What unique statuses appear across batches in a dataset?
      instructions:
      - text: Get the unique values of batch field {FIELD}.
        slots:
          FIELD: path.FIELD
      - text: List distinct {FIELD} values for batches in dataset {dataSet}.
        slots:
          FIELD: path.FIELD
          dataSet: query.dataSet
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches/{BATCH_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a catalog batch
      effect: read
      questions:
      - How do I get the details of one catalog batch by its ID?
      - Can I get aggregated status, metrics and errors for a batch in one response?
      instructions:
      - text: Show catalog batch {BATCH_ID}.
        slots:
          BATCH_ID: path.BATCH_ID
      - text: Get batch {BATCH_ID} with aggregate={aggregate}.
        slots:
          BATCH_ID: path.BATCH_ID
          aggregate: query.aggregate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches/{BATCH_ID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a catalog batch's details
      effect: write
      questions:
      - How do I overwrite a batch record with a full new version?
      - Can I guard a full batch update with an if-match version check?
      instructions:
      - text: Replace batch {BATCH_ID} with status {status}.
        slots:
          BATCH_ID: path.BATCH_ID
          status: requestBody.status
      - text: Fully update batch {BATCH_ID} only if version {if-match} matches.
        slots:
          BATCH_ID: path.BATCH_ID
          if-match: header.if-match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches/{BATCH_ID}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a catalog batch under a chosen ID
      effect: write
      questions:
      - Can I create a batch using a specific ID instead of letting the catalog assign one?
      - How do I create a batch at a known batch ID path?
      instructions:
      - text: Create batch {BATCH_ID} with status {status}.
        slots:
          BATCH_ID: path.BATCH_ID
          status: requestBody.status
      - text: Register a new batch at ID {BATCH_ID} holding {recordCount} records.
        slots:
          BATCH_ID: path.BATCH_ID
          recordCount: requestBody.recordCount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches/{BATCH_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a catalog batch (deprecated)
      effect: destructive
      questions:
      - How do I delete a batch record from the catalog?
      - Is the catalog's delete-batch endpoint still supported?
      instructions:
      - text: Delete catalog batch {BATCH_ID}.
        slots:
          BATCH_ID: path.BATCH_ID
      - text: Remove batch {BATCH_ID} using the deprecated catalog endpoint.
        slots:
          BATCH_ID: path.BATCH_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batches/{BATCH_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update selected fields on a catalog batch
      effect: write
      questions:
      - Can I change just a few attributes of a batch without resending all of it?
      - How do I patch the failed record count on an existing batch?
      instructions:
      - text: Set the status of batch {BATCH_ID} to {status}.
        slots:
          BATCH_ID: path.BATCH_ID
          status: requestBody.status
      - text: Patch batch {BATCH_ID} to record {failedRecordCount} failed records.
        slots:
          BATCH_ID: path.BATCH_ID
          failedRecordCount: requestBody.failedRecordCount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batch/execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run many assets through a published workflow
      effect: write
      questions:
      - How do I process a batch of assets through one of my published workflows?
      - Can each run in a workflow batch supply different inputs per node?
      instructions:
      - text: Start a workflow batch job with {workflow}.
        slots:
          workflow: requestBody.workflow
      - text: Execute my published workflow over these assets as one batch.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batch/{batchId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check progress of a workflow batch job
      effect: read
      questions:
      - How far along is my workflow batch job?
      - Can I see how many assets in a workflow batch have finished or failed?
      instructions:
      - text: Get the status of workflow batch {batchId}.
        slots:
          batchId: path.batchId
      - text: Show progress counters for batch job {batchId}.
        slots:
          batchId: path.batchId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batch/{batchId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running workflow batch job
      effect: destructive
      questions:
      - How do I stop a workflow batch that's still pending or running?
      - Will assets already being processed finish if I cancel the batch?
      instructions:
      - text: Cancel workflow batch {batchId}.
        slots:
          batchId: path.batchId
      - text: Stop batch job {batchId} so no more assets are processed.
        slots:
          batchId: path.batchId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batch/{batchId}/executions'].get
  update:
    x-apievangelist-phrasing:
      intent: List per-asset results in a workflow batch
      effect: read
      questions:
      - How do I see the result for each asset processed in a workflow batch?
      - Can I list only the failed executions in a batch job?
      instructions:
      - text: List executions in workflow batch {batchId}.
        slots:
          batchId: path.batchId
      - text: Show {status} executions for batch {batchId}.
        slots:
          status: query.status
          batchId: path.batchId
      - text: List {limit} executions of batch {batchId} from offset {offset}.
        slots:
          limit: query.limit
          batchId: path.batchId
          offset: query.offset
      method: generated
      generated: '2026-09-26'