Dolby · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OptiView Ads Templates API

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

$.info

$.paths['/api/v1/templates'].get

$.paths['/api/v1/templates'].post

$.paths['/api/v1/templates'].delete

$.paths['/api/v1/templates/{templateId}'].get

$.paths['/api/v1/templates/{templateId}'].delete

$.paths['/api/v1/templates/{templateId}'].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 OptiView Ads Templates API
  version: 1.0.0
extends: openapi/dolby-templates-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/v1/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List ad break templates
      effect: read
      questions:
      - Which reusable ad break templates have I defined?
      - Can I sort my break templates by name?
      instructions:
      - text: List all my break templates.
      - text: Show break templates matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an ad break template
      effect: write
      questions:
      - How do I create a reusable template with a default break duration?
      - Can a break template carry several variants for different viewer devices?
      - Can I link a new template to specific channels and events?
      instructions:
      - text: Create a break template named {name} with variant {variant}.
        slots:
          name: requestBody.name
          variant: requestBody.variant
      - text: Create a template with variant {variant} and a default duration of {duration} seconds.
        slots:
          variant: requestBody.variant
          duration: requestBody.duration
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/templates'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete break templates
      effect: destructive
      questions:
      - Can I delete several break templates in one go?
      - How do I remove a list of templates by their IDs?
      instructions:
      - text: Delete break templates {ids}.
        slots:
          ids: requestBody.ids
      - text: Bulk remove the templates {ids}.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/templates/{templateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one break template
      effect: read
      questions:
      - What variants and playback controls does a particular template define?
      - Which channels and events is one template linked to?
      instructions:
      - text: Show break template {templateId}.
        slots:
          templateId: path.templateId
      - text: Get the duration and resume offset of template {templateId}.
        slots:
          templateId: path.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/templates/{templateId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single break template
      effect: destructive
      questions:
      - How do I remove one break template I no longer need?
      - Can I delete just a single template by its ID?
      instructions:
      - text: Delete template {templateId}.
        slots:
          templateId: path.templateId
      - text: Remove the single break template {templateId}.
        slots:
          templateId: path.templateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/templates/{templateId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a break template
      effect: write
      questions:
      - Can I change the default duration on an existing break template?
      - How do I add skip or snapback controls to a template I already made?
      instructions:
      - text: Set the default duration of template {templateId} to {duration} seconds.
        slots:
          templateId: path.templateId
          duration: requestBody.duration
      - text: Link template {templateId} to channels {channelIds}.
        slots:
          templateId: path.templateId
          channelIds: requestBody.channelIds
      - text: Change the resume offset of template {templateId} to {resumeOffset} seconds.
        slots:
          templateId: path.templateId
          resumeOffset: requestBody.resumeOffset
      method: generated
      generated: '2026-10-01'