Dolby · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Director API

3 actions 3 updates phrasing extends openapi/dolby-director-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 3

$.info
$.paths['/api/director/publish'].post
$.paths['/api/director/subscribe'].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 API
  version: 1.0.0
extends: openapi/dolby-director-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: 2
- target: $.paths['/api/director/publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a URL and auth to publish a stream
      effect: write
      questions:
      - How does a broadcaster get the URL and authorization to start publishing a stream?
      - What do I call before pushing video into a stream name?
      instructions:
      - text: Get publishing credentials for stream {stream_name}.
        slots:
          stream_name: requestBody.streamName
      - text: Request a publish URL for stream {stream_name} on account {stream_account_id}.
        slots:
          stream_name: requestBody.streamName
          stream_account_id: requestBody.streamAccountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/director/subscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a URL and auth to watch a stream
      effect: write
      questions:
      - How does a viewer get the URL and authorization to watch a stream?
      - What do I call before playing back a stream as a subscriber?
      instructions:
      - text: Get viewing credentials for stream {stream_name}.
        slots:
          stream_name: requestBody.streamName
      - text: Request a subscribe URL for stream {stream_name} on account {stream_account_id}.
        slots:
          stream_name: requestBody.streamName
          stream_account_id: requestBody.streamAccountId
      method: generated
      generated: '2026-10-01'