Dolby · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Director Whip API

2 actions 2 updates phrasing extends openapi/dolby-whip-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 2

$.info
$.paths['/api/whip/{streamName}'].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 Director Whip API
  version: 1.0.0
extends: openapi/dolby-whip-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: 1
- target: $.paths['/api/whip/{streamName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a stream over WHIP
      effect: write
      questions:
      - Can I publish a WebRTC stream with a WHIP-compatible encoder?
      - What does the WHIP endpoint return after I send my SDP offer?
      instructions:
      - text: Start publishing to stream {streamName} over WHIP.
        slots:
          streamName: path.streamName
      - text: Publish stream {streamName} over WHIP using codec {codec} as source {sourceId}.
        slots:
          streamName: path.streamName
          codec: query.codec
          sourceId: query.sourceId
      method: generated
      generated: '2026-10-01'