Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Segmentation Service Previews API

4 actions 4 updates phrasing extends openapi/adobe-suite-previews-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 4

$.info

$.paths['/preview'].post

$.paths['/preview/{PREVIEW_ID}'].get

$.paths['/preview/{PREVIEW_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 Segmentation Service Previews API
  version: 1.0.0
extends: openapi/adobe-suite-previews-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: 3
- target: $.paths['/preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a segment preview job
      effect: write
      questions:
      - How do I preview which profiles a PQL expression would qualify?
      - Can I choose the identity graph used when previewing an audience?
      instructions:
      - text: Preview profiles matching {predicateExpression}.
        slots:
          predicateExpression: requestBody.predicateExpression
      - text: Start a preview job for {predicateExpression} using graph {graphType}.
        slots:
          predicateExpression: requestBody.predicateExpression
          graphType: requestBody.graphType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/preview/{PREVIEW_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the results of a preview job
      effect: read
      questions:
      - Where can I see the sample profiles returned by my preview job?
      - Can I page through preview results with an offset and limit?
      instructions:
      - text: Show the results of preview job {PREVIEW_ID}.
        slots:
          PREVIEW_ID: path.PREVIEW_ID
      - text: Get {limit} preview results from {PREVIEW_ID} starting at {offset}.
        slots:
          limit: query.limit
          PREVIEW_ID: path.PREVIEW_ID
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/preview/{PREVIEW_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel or delete a preview job
      effect: destructive
      questions:
      - Can I cancel a preview job that is still running?
      - What deletes a preview job I no longer need?
      instructions:
      - text: Cancel preview job {PREVIEW_ID}.
        slots:
          PREVIEW_ID: path.PREVIEW_ID
      - text: Delete preview {PREVIEW_ID}.
        slots:
          PREVIEW_ID: path.PREVIEW_ID
      method: generated
      generated: '2026-09-26'