Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Media Edge Ad API

4 actions 4 updates phrasing extends openapi/adobe-suite-ad-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['/adStart'].post
$.paths['/adComplete'].post
$.paths['/adSkip'].post

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 Media Edge Ad API
  version: 1.0.0
extends: openapi/adobe-suite-ad-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['/adStart'].post
  update:
    x-apievangelist-phrasing:
      intent: Track the start of an ad
      effect: write
      questions:
      - How do I tell Media Analytics that an ad began playing?
      - What event do I send when an ad break starts an ad?
      instructions:
      - text: Send an ad start event.
      - text: Record ad start with events {events}.
        slots:
          events: requestBody.events
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adComplete'].post
  update:
    x-apievangelist-phrasing:
      intent: Track an ad finishing
      effect: write
      questions:
      - How do I signal that an ad played to the end?
      - Which event marks an ad as completed?
      instructions:
      - text: Send an ad complete event.
      - text: Record ad completion with events {events}.
        slots:
          events: requestBody.events
      method: generated
      generated: '2026-09-26'
- target: $.paths['/adSkip'].post
  update:
    x-apievangelist-phrasing:
      intent: Track a skipped ad
      effect: write
      questions:
      - How do I report that a viewer skipped an ad?
      - Can I track ad skips separately from completions?
      instructions:
      - text: Send an ad skip event.
      - text: Record that the ad was skipped with events {events}.
        slots:
          events: requestBody.events
      method: generated
      generated: '2026-09-26'