Dolby · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for THEOlive Schedulers API

6 actions 6 updates phrasing extends openapi/dolby-schedulers-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 6

$.info

$.paths['/schedulers'].get

$.paths['/schedulers'].post

$.paths['/schedulers/{id}'].get

$.paths['/schedulers/{id}'].delete

$.paths['/schedulers/{id}'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for THEOlive Schedulers API
  version: 1.0.0
extends: openapi/dolby-schedulers-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: 5
- target: $.paths['/schedulers'].get
  update:
    x-apievangelist-phrasing:
      intent: List channel schedulers
      effect: read
      questions:
      - Which schedules are set up to start my channels automatically?
      - Can I filter schedulers by status and sort them?
      instructions:
      - text: List all my schedulers.
      - text: Show schedulers with status {status}, sorted by {sort_by}.
        slots:
          status: query.status
          sort_by: query.sortBy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schedulers'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule channels to run at a set time
      effect: write
      questions:
      - How do I schedule a channel to go live at a specific date and time?
      - Can a scheduler recur and cover several channels?
      instructions:
      - text: Create scheduler {name} starting {start_date} at {start_time}.
        slots:
          name: requestBody.name
          start_date: requestBody.startDate
          start_time: requestBody.startTime
      - text: Schedule channels {channel_ids} as {name} on {start_date} at {start_time} in time zone {time_zone}.
        slots:
          channel_ids: requestBody.channelIds
          name: requestBody.name
          start_date: requestBody.startDate
          start_time: requestBody.startTime
          time_zone: requestBody.timeZone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schedulers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scheduler's details
      effect: read
      questions:
      - When does a particular scheduler start and end?
      - Can I look up one scheduler by ID?
      instructions:
      - text: Show scheduler {scheduler_id}.
        slots:
          scheduler_id: path.id
      - text: Fetch the timing and channels of scheduler {scheduler_id}.
        slots:
          scheduler_id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schedulers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scheduler
      effect: destructive
      questions:
      - How do I cancel a schedule permanently?
      - Can a scheduler be deleted by its ID?
      instructions:
      - text: Delete scheduler {scheduler_id}.
        slots:
          scheduler_id: path.id
      - text: Remove scheduler {scheduler_id} for good.
        slots:
          scheduler_id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schedulers/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a scheduler
      effect: write
      questions:
      - Can I change the start time of a scheduler I already made?
      - How do I pause a scheduler without deleting it?
      instructions:
      - text: Move scheduler {scheduler_id} to start at {start_time}.
        slots:
          scheduler_id: path.id
          start_time: requestBody.startTime
      - text: Set scheduler {scheduler_id} enabled to {enabled}.
        slots:
          scheduler_id: path.id
          enabled: requestBody.enabled
      - text: Change scheduler {scheduler_id} recurrence to {recurrence}.
        slots:
          scheduler_id: path.id
          recurrence: requestBody.recurrence
      method: generated
      generated: '2026-10-01'