Mux · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mux Incidents API

4 actions 4 updates phrasing extends openapi/mux-com-incidents-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Mux's API. It is a proposal applied on top of the contract, not a document Mux publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/data/v1/incidents'].get
$.paths['/data/v1/incidents/{INCIDENT_ID}'].get
$.paths['/data/v1/incidents/{INCIDENT_ID}/related'].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 Mux Incidents API
  version: 1.0.0
extends: openapi/mux-com-incidents-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/data/v1/incidents'].get
  update:
    x-apievangelist-phrasing:
      intent: List video quality incidents
      effect: read
      questions:
      - Are there any open playback incidents affecting my viewers right now?
      - Can I list incidents by severity or status?
      instructions:
      - text: List my incidents.
      - text: List {status} incidents with severity {severity}.
        slots:
          status: query.status
          severity: query.severity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/incidents/{INCIDENT_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an incident's details
      effect: read
      questions:
      - What happened during a specific playback incident?
      - Can I look up one incident by its ID?
      instructions:
      - text: Show incident {incident_id}.
        slots:
          incident_id: path.INCIDENT_ID
      - text: Get the details of incident {incident_id}.
        slots:
          incident_id: path.INCIDENT_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/incidents/{INCIDENT_ID}/related'].get
  update:
    x-apievangelist-phrasing:
      intent: List incidents related to an incident
      effect: read
      questions:
      - Which other incidents seem connected to this one?
      - Is this playback incident part of a bigger pattern of related issues?
      instructions:
      - text: List incidents related to {incident_id}.
        slots:
          incident_id: path.INCIDENT_ID
      - text: Find incidents linked to incident {incident_id}, ordered by {order_by}.
        slots:
          incident_id: path.INCIDENT_ID
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'