# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Millicast Transcoder Scheduler API
  version: 1.0.0
extends: openapi/dolby-transcoderscheduler-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: 6
- target: $.paths['/api/transcoders/schedule'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule transcoders to start and stop
      effect: write
      questions:
      - How do I schedule transcoders to start and stop automatically?
      - Can a transcoder schedule recur?
      instructions:
      - text: Create a transcoder schedule named {name}.
        slots:
          name: requestBody.name
      - text: Schedule transcoders {transcoderIds} as {name} from {start} to {stop}.
        slots:
          name: requestBody.name
          transcoderIds: requestBody.transcoderIds
          start: requestBody.start
          stop: requestBody.stop
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/transcoders/schedule/{scheduleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transcoder schedule
      effect: read
      questions:
      - What does one transcoder schedule look like in summary?
      - Can I read a transcoder schedule by its ID?
      instructions:
      - text: Show transcoder schedule {scheduleId}.
        slots:
          scheduleId: path.scheduleId
      - text: Get the summary of schedule {scheduleId}.
        slots:
          scheduleId: path.scheduleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/transcoders/schedule/{scheduleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a transcoder schedule
      effect: write
      questions:
      - Can I change the start or stop time of an existing transcoder schedule?
      - Is it possible to add transcoders to a schedule I already made?
      instructions:
      - text: Change schedule {scheduleId} to start at {start}.
        slots:
          scheduleId: path.scheduleId
          start: requestBody.start
      - text: Set the transcoders on schedule {scheduleId} to {transcoderIds}.
        slots:
          scheduleId: path.scheduleId
          transcoderIds: requestBody.transcoderIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/transcoders/schedule/{scheduleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a transcoder schedule
      effect: destructive
      questions:
      - How do I cancel a transcoder schedule?
      - Where do I find the schedule ID needed to delete a schedule?
      instructions:
      - text: Delete transcoder schedule {scheduleId}.
        slots:
          scheduleId: path.scheduleId
      - text: Cancel schedule {scheduleId}.
        slots:
          scheduleId: path.scheduleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/transcoders/schedule/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List all transcoder schedules
      effect: read
      questions:
      - Which transcoder schedules exist on my account?
      - Can I filter all schedules by their status?
      instructions:
      - text: List all transcoder schedules, page {page} with {itemsOnPage} per page.
        slots:
          page: query.page
          itemsOnPage: query.itemsOnPage
      - text: Show schedules with status {status}, page {page}, {itemsOnPage} each.
        slots:
          status: query.status
          page: query.page
          itemsOnPage: query.itemsOnPage
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/transcoders/{transcoderId}/schedule/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List schedules for one transcoder
      effect: read
      questions:
      - Which schedules apply to a specific transcoder?
      - Can I see only the schedules attached to one transcoder?
      instructions:
      - text: List schedules for transcoder {transcoderId}, page {page} with {itemsOnPage} per page.
        slots:
          transcoderId: path.transcoderId
          page: query.page
          itemsOnPage: query.itemsOnPage
      - text: Show the {status} schedules of transcoder {transcoderId}, page {page}, {itemsOnPage} each.
        slots:
          transcoderId: path.transcoderId
          status: query.status
          page: query.page
          itemsOnPage: query.itemsOnPage
      method: generated
      generated: '2026-10-01'