Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Media Edge Chapter API

4 actions 4 updates phrasing extends openapi/adobe-suite-chapter-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['/chapterStart'].post
$.paths['/chapterComplete'].post
$.paths['/chapterSkip'].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 Chapter API
  version: 1.0.0
extends: openapi/adobe-suite-chapter-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['/chapterStart'].post
  update:
    x-apievangelist-phrasing:
      intent: Track the start of a chapter
      effect: write
      questions:
      - How do I signal that a video chapter has begun?
      - What event marks the beginning of a chapter?
      instructions:
      - text: Send a chapter start event.
      - text: Record chapter start with events {events}.
        slots:
          events: requestBody.events
      method: generated
      generated: '2026-09-26'
- target: $.paths['/chapterComplete'].post
  update:
    x-apievangelist-phrasing:
      intent: Track a chapter finishing
      effect: write
      questions:
      - How do I report that a viewer finished a chapter?
      - Which event marks a chapter as completed?
      instructions:
      - text: Send a chapter complete event.
      - text: Record chapter completion with events {events}.
        slots:
          events: requestBody.events
      method: generated
      generated: '2026-09-26'
- target: $.paths['/chapterSkip'].post
  update:
    x-apievangelist-phrasing:
      intent: Track a skipped chapter
      effect: write
      questions:
      - How do I record that a viewer skipped a chapter?
      - Can I track chapter skips in media analytics?
      instructions:
      - text: Send a chapter skip event.
      - text: Record that the chapter was skipped with events {events}.
        slots:
          events: requestBody.events
      method: generated
      generated: '2026-09-26'