Dolby · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Millicast Stream API

4 actions 4 updates phrasing extends openapi/dolby-stream-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['/api/stream/stop'].post
$.paths['/api/stream/stop/all'].post
$.paths['/api/stream/reprioritize'].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 Millicast Stream API
  version: 1.0.0
extends: openapi/dolby-stream-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['/api/stream/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop one active stream
      effect: destructive
      questions:
      - How do I force-stop a single live stream that's broadcasting?
      - Can I end one active stream by its stream ID?
      instructions:
      - text: Stop active stream {stream_id}.
        slots:
          stream_id: requestBody.streamId
      - text: End the live broadcast for stream {stream_id}.
        slots:
          stream_id: requestBody.streamId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/stream/stop/all'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop every active stream on the account
      effect: destructive
      questions:
      - Is there an emergency way to stop all live streams on my account at once?
      - What happens if I stop every active stream?
      instructions:
      - text: Stop all active streams on my account.
      - text: Shut down every live stream right now.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/stream/reprioritize'].post
  update:
    x-apievangelist-phrasing:
      intent: Change an active stream's priority
      effect: write
      questions:
      - Can I change the priority of a stream that's already live?
      - Does reprioritizing a stream restart it?
      instructions:
      - text: Set the priority of the stream on token {token_id} to {update_priority}.
        slots:
          token_id: requestBody.tokenId
          update_priority: requestBody.updatePriority
      - text: Reprioritize the live stream for publish token {token_id} to {update_priority} and restart it.
        slots:
          token_id: requestBody.tokenId
          update_priority: requestBody.updatePriority
      method: generated
      generated: '2026-10-01'