# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for THEOlive Custom Endpoints API
  version: 1.0.0
extends: openapi/dolby-custom-endpoints-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['/channels/{id}/custom-endpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List a channel's custom endpoints
      effect: read
      questions:
      - Which custom endpoints are configured on a channel?
      - Can I list all custom endpoints for one channel at once?
      instructions:
      - text: List the custom endpoints of channel {id}.
        slots:
          id: path.id
      - text: Show every custom endpoint defined on channel {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/channels/{id}/custom-endpoints'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a custom endpoint to a channel
      effect: write
      questions:
      - How do I add a custom endpoint with my own CDN to a channel?
      - What fields are required to create a custom endpoint?
      instructions:
      - text: Create custom endpoint {name} on channel {id} with source {src} of type {srcType} via {provider} on CDN {cdn} at priority {priority}.
        slots:
          id: path.id
          name: requestBody.name
          src: requestBody.src
          srcType: requestBody.srcType
          provider: requestBody.provider
          cdn: requestBody.cdn
          priority: requestBody.priority
      - text: Add a custom endpoint named {name} to channel {id} pulling from {src}.
        slots:
          id: path.id
          name: requestBody.name
          src: requestBody.src
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-endpoints/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom endpoint
      effect: read
      questions:
      - What is the configuration of a single custom endpoint?
      - Can I look up a custom endpoint directly by its ID?
      instructions:
      - text: Show custom endpoint {id}.
        slots:
          id: path.id
      - text: Get the source, CDN and priority of custom endpoint {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-endpoints/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom endpoint
      effect: destructive
      questions:
      - How do I remove a custom endpoint I no longer need?
      - Is deleting a custom endpoint done by its own ID rather than the channel?
      instructions:
      - text: Delete custom endpoint {id}.
        slots:
          id: path.id
      - text: Remove the custom endpoint with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-endpoints/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom endpoint
      effect: write
      questions:
      - Can I change the CDN or priority of an existing custom endpoint?
      - How would I point a custom endpoint at a new source URL?
      instructions:
      - text: Change the source of custom endpoint {id} to {src}.
        slots:
          id: path.id
          src: requestBody.src
      - text: Set the priority of custom endpoint {id} to {priority}.
        slots:
          id: path.id
          priority: requestBody.priority
      method: generated
      generated: '2026-10-01'