Mux · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mux Signing Keys API

5 actions 5 updates phrasing extends openapi/mux-com-signing-keys-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 5

$.info
$.paths['/system/v1/signing-keys'].get
$.paths['/system/v1/signing-keys'].post
$.paths['/system/v1/signing-keys/{SIGNING_KEY_ID}'].get
$.paths['/system/v1/signing-keys/{SIGNING_KEY_ID}'].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 Mux Signing Keys API
  version: 1.0.0
extends: openapi/mux-com-signing-keys-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: 4
- target: $.paths['/system/v1/signing-keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List signing keys
      effect: read
      questions:
      - Which signing keys exist for signing my playback JWTs?
      - Can I page through all my system signing keys?
      instructions:
      - text: List my signing keys.
      - text: List signing keys, {limit} per page.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/system/v1/signing-keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a signing key
      effect: write
      questions:
      - How do I get a key pair for signing secure playback tokens?
      - Does Mux keep the private key when it creates a signing key?
      instructions:
      - text: Create a new signing key.
      - text: Generate an RSA signing key pair for signed playback.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/system/v1/signing-keys/{SIGNING_KEY_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a signing key
      effect: read
      questions:
      - When was a particular signing key created?
      - Can I look up one signing key by its ID?
      instructions:
      - text: Show signing key {signing_key_id}.
        slots:
          signing_key_id: path.SIGNING_KEY_ID
      - text: Get details of signing key {signing_key_id}.
        slots:
          signing_key_id: path.SIGNING_KEY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/system/v1/signing-keys/{SIGNING_KEY_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a signing key
      effect: destructive
      questions:
      - What happens to tokens signed with a key after I delete it?
      - How do I retire a compromised signing key?
      instructions:
      - text: Delete signing key {signing_key_id}.
        slots:
          signing_key_id: path.SIGNING_KEY_ID
      - text: Revoke signing key {signing_key_id} so its JWTs stop working.
        slots:
          signing_key_id: path.SIGNING_KEY_ID
      method: generated
      generated: '2026-09-26'