# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mux Playback Restrictions API
  version: 1.0.0
extends: openapi/mux-com-playback-restrictions-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: 6
- target: $.paths['/video/v1/playback-restrictions'].get
  update:
    x-apievangelist-phrasing:
      intent: List playback restrictions
      effect: read
      questions:
      - Which playback restrictions have I set up?
      - Can I page through all my playback restrictions?
      instructions:
      - text: List my playback restrictions.
      - text: List playback restrictions, {limit} per page.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/playback-restrictions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a playback restriction
      effect: write
      questions:
      - How do I stop other websites from embedding my videos?
      - Can I restrict playback by referrer domain and user agent?
      instructions:
      - text: Create a playback restriction with referrer rules {referrer} and user agent rules {user_agent}.
        slots:
          referrer: requestBody.referrer
          user_agent: requestBody.user_agent
      - text: Set up a new restriction limiting playback to {referrer} with {user_agent}.
        slots:
          referrer: requestBody.referrer
          user_agent: requestBody.user_agent
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a playback restriction
      effect: read
      questions:
      - Which domains does a given playback restriction allow?
      - Can I view the settings of one playback restriction?
      instructions:
      - text: Show playback restriction {playback_restriction_id}.
        slots:
          playback_restriction_id: path.PLAYBACK_RESTRICTION_ID
      - text: Get the rules for restriction {playback_restriction_id}.
        slots:
          playback_restriction_id: path.PLAYBACK_RESTRICTION_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a playback restriction
      effect: destructive
      questions:
      - How do I remove a playback restriction I no longer need?
      - Can I delete a single playback restriction?
      instructions:
      - text: Delete playback restriction {playback_restriction_id}.
        slots:
          playback_restriction_id: path.PLAYBACK_RESTRICTION_ID
      - text: Remove restriction {playback_restriction_id}.
        slots:
          playback_restriction_id: path.PLAYBACK_RESTRICTION_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/referrer'].put
  update:
    x-apievangelist-phrasing:
      intent: Change allowed referrer domains
      effect: write
      questions:
      - How do I update which domains are allowed to play my videos?
      - Can I allow playback when there's no Referer header?
      instructions:
      - text: Allow domains {allowed_domains} on restriction {playback_restriction_id}.
        slots:
          allowed_domains: requestBody.allowed_domains
          playback_restriction_id: path.PLAYBACK_RESTRICTION_ID
      - text: Replace restriction {playback_restriction_id} domains with {allowed_domains} and set no-referrer to {allow_no_referrer}.
        slots:
          playback_restriction_id: path.PLAYBACK_RESTRICTION_ID
          allowed_domains: requestBody.allowed_domains
          allow_no_referrer: requestBody.allow_no_referrer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/user_agent'].put
  update:
    x-apievangelist-phrasing:
      intent: Change user agent playback rules
      effect: write
      questions:
      - Can I block playback from high-risk user agents?
      - What happens to requests with no user agent under a playback restriction?
      instructions:
      - text: Set restriction {playback_restriction_id} to allow no user agent {allow_no_user_agent} and high-risk agents {allow_high_risk_user_agent}.
        slots:
          playback_restriction_id: path.PLAYBACK_RESTRICTION_ID
          allow_no_user_agent: requestBody.allow_no_user_agent
          allow_high_risk_user_agent: requestBody.allow_high_risk_user_agent
      - text: Block high-risk user agents on restriction {playback_restriction_id} with {allow_high_risk_user_agent}, no-UA {allow_no_user_agent}.
        slots:
          playback_restriction_id: path.PLAYBACK_RESTRICTION_ID
          allow_high_risk_user_agent: requestBody.allow_high_risk_user_agent
          allow_no_user_agent: requestBody.allow_no_user_agent
      method: generated
      generated: '2026-09-26'