Dolby · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Millicast Media Distributions API

9 actions 9 updates phrasing extends openapi/dolby-mediadistributions-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 9

$.info
$.paths['/api/v3/media/distributions'].get
$.paths['/api/v3/media/distributions'].post
$.paths['/api/v3/media/distributions/{id}'].get
$.paths['/api/v3/media/distributions/{id}'].delete
$.paths['/api/v3/media/distributions/{id}'].patch
$.paths['/api/v3/media/distributions/{id}/security/keys'].get
$.paths['/api/v3/media/distributions/{id}/security/keys'].post
$.paths['/api/v3/media/distributions/{id}/security/keys/{keyId}'].delete

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 Media Distributions API
  version: 1.0.0
extends: openapi/dolby-mediadistributions-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: 8
- target: $.paths['/api/v3/media/distributions'].get
  update:
    x-apievangelist-phrasing:
      intent: List media distributions
      effect: read
      questions:
      - Which media distributions do I have for HLS playback?
      - Can I find the default media distribution?
      instructions:
      - text: List my media distributions.
      - text: Find media distributions named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/media/distributions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a media distribution
      effect: write
      questions:
      - How do I set up a distribution for viewing HLS media assets?
      - Can a new media distribution be made the default?
      instructions:
      - text: Create a media distribution named {name}.
        slots:
          name: requestBody.name
      - text: Create media distribution {name} as default ({default}).
        slots:
          name: requestBody.name
          default: requestBody.default
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/media/distributions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a media distribution
      effect: read
      questions:
      - What settings does a media distribution have?
      - Can I read a media distribution by its ID?
      instructions:
      - text: Show media distribution {id}.
        slots:
          id: path.id
      - text: Get the settings of media distribution {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/media/distributions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a media distribution
      effect: destructive
      questions:
      - How do I delete a media distribution?
      - Can I remove a media distribution I no longer use?
      instructions:
      - text: Delete media distribution {id}.
        slots:
          id: path.id
      - text: Remove media distribution {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/media/distributions/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a media distribution
      effect: write
      questions:
      - Can I rename a media distribution?
      - Is it possible to make an existing media distribution the default?
      instructions:
      - text: Rename media distribution {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Make media distribution {id} the default by setting default to {default}.
        slots:
          id: path.id
          default: requestBody.default
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/media/distributions/{id}/security/keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List a media distribution's security keys
      effect: read
      questions:
      - Which security keys protect a media distribution?
      - Can I see the signing keys on a media distribution?
      instructions:
      - text: List security keys of media distribution {id}.
        slots:
          id: path.id
      - text: Show the signing keys for media distribution {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/media/distributions/{id}/security/keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a security key to a media distribution
      effect: write
      questions:
      - How many security keys can a media distribution have?
      - Can I add a named security key to a media distribution?
      instructions:
      - text: Add security key {key} to media distribution {id}.
        slots:
          id: path.id
          key: requestBody.key
      - text: Create security key {name} with value {key} on media distribution {id}.
        slots:
          id: path.id
          name: requestBody.name
          key: requestBody.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/media/distributions/{id}/security/keys/{keyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a media distribution security key
      effect: destructive
      questions:
      - How do I revoke a security key on a media distribution?
      - Can I delete just one of a media distribution's keys?
      instructions:
      - text: Delete security key {keyId} from media distribution {id}.
        slots:
          id: path.id
          keyId: path.keyId
      - text: Revoke key {keyId} on media distribution {id}.
        slots:
          id: path.id
          keyId: path.keyId
      method: generated
      generated: '2026-10-01'