# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Dolby Monitoring API
  version: 1.0.0
extends: openapi/dolby-monitoring-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: 9
- target: $.paths['/api/monitoring/streams'].get
  update:
    x-apievangelist-phrasing:
      intent: List live and recent streams in detail
      effect: read
      questions:
      - Which streams are live right now or ended in the last hour?
      - Can I list only multisource or restreaming streams that are active?
      instructions:
      - text: List detailed info on all active and recently ended streams.
      - text: Show detailed stream monitoring for streams matching {searchSubstring}.
        slots:
          searchSubstring: query.searchSubstring
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/monitoring/streams/{streamName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get full monitoring details of a stream
      effect: read
      questions:
      - What are the full feed details of a stream I'm monitoring?
      - Does getting stream details need the LiveMonitoring feature?
      instructions:
      - text: Show full stream details for {streamName}.
        slots:
          streamName: path.streamName
      - text: Get the feed-level monitoring details of stream {streamName}.
        slots:
          streamName: path.streamName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/monitoring/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: List a lightweight summary of streams
      effect: read
      questions:
      - Can I get a quick summary list of active and recently ended streams?
      - Is there a lighter stream list I can filter by cluster?
      instructions:
      - text: List a summary of active and recently ended streams.
      - text: Show stream summaries in cluster {cluster}.
        slots:
          cluster: query.cluster
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/monitoring/summary/{streamName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a lightweight summary of one stream
      effect: read
      questions:
      - Can I get a stream's summary without all the feed details?
      - What is the quick status of one stream by name?
      instructions:
      - text: Show the summary of stream {streamName}.
        slots:
          streamName: path.streamName
      - text: Get a lite status for stream {streamName} without feed details.
        slots:
          streamName: path.streamName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/monitoring/channels/{channelId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get health status of a channel
      effect: read
      questions:
      - Are a channel's ingests, engines and distributions healthy right now?
      - Can I check the overall status of one channel at a glance?
      instructions:
      - text: Show monitoring status for channel {channelId}.
        slots:
          channelId: path.channelId
      - text: Check the health of channel {channelId}.
        slots:
          channelId: path.channelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/monitoring/ingests/{ingestId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metrics for one ingest
      effect: read
      questions:
      - What packet loss and round-trip time is one ingest seeing?
      - Can I get bitrate metrics for a single ingest over a time window?
      instructions:
      - text: Show monitoring metrics for ingest {ingestId}.
        slots:
          ingestId: path.ingestId
      - text: Get packet loss and bitrate for ingest {ingestId} from {start} to {end}.
        slots:
          ingestId: path.ingestId
          start: query.start
          end: query.end
      method: generated
      generated: '2026-10-01'
- target: $.paths['/monitoring/engines/{engineId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get rendition metrics for one engine
      effect: read
      questions:
      - How are the renditions of a single engine performing?
      - Can I see one engine's rendition metrics over a time window?
      instructions:
      - text: Show monitoring metrics for engine {engineId}.
        slots:
          engineId: path.engineId
      - text: Get rendition metrics for engine {engineId} from {start} to {end}.
        slots:
          engineId: path.engineId
          start: query.start
          end: query.end
      method: generated
      generated: '2026-10-01'
- target: $.paths['/monitoring/channels/{channelId}/ingests'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metrics for all ingests of a channel
      effect: read
      questions:
      - How are all the ingests on a channel performing together?
      - Can I pull ingest metrics for every feed on one channel at once?
      instructions:
      - text: Show detailed ingest metrics for every ingest on channel {channelId}.
        slots:
          channelId: path.channelId
      - text: Get ingest monitoring for channel {channelId} from {start} to {end}.
        slots:
          channelId: path.channelId
          start: query.start
          end: query.end
      method: generated
      generated: '2026-10-01'
- target: $.paths['/monitoring/channels/{channelId}/engines'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metrics for all engines of a channel
      effect: read
      questions:
      - How are all the engines on a channel performing?
      - Can I pull rendition metrics for every engine of one channel at once?
      instructions:
      - text: Show detailed engine metrics for every engine on channel {channelId}.
        slots:
          channelId: path.channelId
      - text: Get engine monitoring for channel {channelId} from {start} to {end}.
        slots:
          channelId: path.channelId
          start: query.start
          end: query.end
      method: generated
      generated: '2026-10-01'