Dolby · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for THEOads Monetized Stream V2 API

4 actions 4 updates phrasing extends openapi/dolby-monetized-stream-v2-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Dolby's API. It is a proposal applied on top of the contract, not a document Dolby publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/v2/monetized-streams'].get

$.paths['/v2/monetized-streams/{monetizedStreamId}/break'].get

$.paths['/v2/monetized-streams/{monetizedStreamId}/overlay'].get

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 THEOads Monetized Stream V2 API
  version: 1.0.0
extends: openapi/dolby-monetized-stream-v2-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/v2/monetized-streams'].get
  update:
    x-apievangelist-phrasing:
      intent: Page through monetized streams
      effect: read
      questions:
      - Can I page through my monetized streams with a limit and skip?
      - How do I list monetized streams a batch at a time?
      instructions:
      - text: List my monetized streams, {limit} per page.
        slots:
          limit: query.limit
      - text: Show monetized streams skipping the first {skip}.
        slots:
          skip: query.skip
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/monetized-streams/{monetizedStreamId}/break'].get
  update:
    x-apievangelist-phrasing:
      intent: Page through a stream's ad breaks
      effect: read
      questions:
      - Can I paginate the ad breaks on a monetized stream?
      - What's the way to list ad breaks for one stream in pages?
      instructions:
      - text: List ad breaks on monetized stream {monetizedStreamId}, {limit} at a time.
        slots:
          monetizedStreamId: path.monetizedStreamId
          limit: query.limit
      - text: Show the next page of ad breaks for {monetizedStreamId} after skipping {skip}.
        slots:
          monetizedStreamId: path.monetizedStreamId
          skip: query.skip
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/monetized-streams/{monetizedStreamId}/overlay'].get
  update:
    x-apievangelist-phrasing:
      intent: Page through a stream's overlays
      effect: read
      questions:
      - Can I paginate the overlay ads on a monetized stream?
      - Which overlays does a stream have, fetched page by page?
      instructions:
      - text: List overlays on monetized stream {monetizedStreamId}, {limit} at a time.
        slots:
          monetizedStreamId: path.monetizedStreamId
          limit: query.limit
      - text: Show the next page of overlays for {monetizedStreamId} after skipping {skip}.
        slots:
          monetizedStreamId: path.monetizedStreamId
          skip: query.skip
      method: generated
      generated: '2026-10-01'