Dolby · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for THEOlive Regions API

5 actions 5 updates phrasing extends openapi/dolby-regions-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 5

$.info
$.paths['/regions'].get
$.paths['/regions/{regionId}'].get
$.paths['/regions/{regionId}/sdi'].get
$.paths['/regions/{regionId}/ndi'].get

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 THEOlive Regions API
  version: 1.0.0
extends: openapi/dolby-regions-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: 4
- target: $.paths['/regions'].get
  update:
    x-apievangelist-phrasing:
      intent: List available streaming regions
      effect: read
      questions:
      - Which regions can I run my channels in?
      - What regions are available to my organization?
      instructions:
      - text: List all regions available to my organization.
      - text: Show me the regions I can deploy engines to.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/regions/{regionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a region's details
      effect: read
      questions:
      - What are the details of a specific region?
      - Can I look up one region by its ID?
      instructions:
      - text: Show region {regionId}.
        slots:
          regionId: path.regionId
      - text: Get the details of region {regionId}.
        slots:
          regionId: path.regionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/regions/{regionId}/sdi'].get
  update:
    x-apievangelist-phrasing:
      intent: List SDI devices in an on-prem region
      effect: read
      questions:
      - Which SDI capture devices are available in my on-prem region?
      - Can I see the SDI inputs attached to an on-premises region?
      instructions:
      - text: List SDI devices in region {regionId}.
        slots:
          regionId: path.regionId
      - text: Show the SDI hardware available in on-prem region {regionId}.
        slots:
          regionId: path.regionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/regions/{regionId}/ndi'].get
  update:
    x-apievangelist-phrasing:
      intent: List NDI sources in an on-prem region
      effect: read
      questions:
      - Which NDI sources can my on-prem region see on the network?
      - Can I discover NDI feeds available in an on-premises region?
      instructions:
      - text: List NDI sources in region {regionId}.
        slots:
          regionId: path.regionId
      - text: Show the NDI feeds discovered in on-prem region {regionId}.
        slots:
          regionId: path.regionId
      method: generated
      generated: '2026-10-01'