Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Media Edge Ad Break API

3 actions 3 updates phrasing extends openapi/adobe-suite-ad-break-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 3

$.info

$.paths['/adBreakStart'].post

$.paths['/adBreakComplete'].post

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 Media Edge Ad Break API
  version: 1.0.0
extends: openapi/adobe-suite-ad-break-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: 2
- target: $.paths['/adBreakStart'].post
  update:
    x-apievangelist-phrasing:
      intent: Signal the start of an ad break
      effect: write
      questions:
      - How do I tell media tracking that an ad break has started?
      - What event do I send when a series of ads begins playing?
      instructions:
      - text: Send an ad break start event.
      - text: Signal ad break start with events {events}.
        slots:
          events: requestBody.events
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adBreakComplete'].post
  update:
    x-apievangelist-phrasing:
      intent: Signal the end of an ad break
      effect: write
      questions:
      - How do I report that an ad break has finished?
      - What event marks the end of a series of ads in media analytics?
      instructions:
      - text: Send an ad break complete event.
      - text: Signal ad break complete with events {events}.
        slots:
          events: requestBody.events
      method: generated
      generated: '2026-09-26'