Dolby · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Director Whep API

2 actions 2 updates phrasing extends openapi/dolby-whep-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/whep/{streamAccountId}/{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 Whep API
  version: 1.0.0
extends: openapi/dolby-whep-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/whep/{streamAccountId}/{streamName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to a stream over WHEP
      effect: write
      questions:
      - How do I play back a stream with WHEP by sending an SDP offer?
      - Can a WHEP subscriber pick a specific source within a stream?
      instructions:
      - text: Subscribe to stream {stream_name} on account {stream_account_id} over WHEP.
        slots:
          stream_name: path.streamName
          stream_account_id: path.streamAccountId
      - text: Open a WHEP session for {stream_name} in account {stream_account_id}, source {source_id}.
        slots:
          stream_name: path.streamName
          stream_account_id: path.streamAccountId
          source_id: query.sourceId
      method: generated
      generated: '2026-10-01'