Wistia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Wistia Channels API

9 actions 9 updates phrasing extends openapi/wistia-channels-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Wistia's API. It is a proposal applied on top of the contract, not a document Wistia publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info

$.paths['/channels'].get

$.paths['/channels'].post

$.paths['/channels/{channelHashedId}'].get

$.paths['/channels/{channelHashedId}'].put

$.paths['/channels/{channelHashedId}'].delete

$.paths['/channels/{hashedId}'].get

$.paths['/channels/{hashedId}'].put

$.paths['/channels/{hashedId}'].delete

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 Wistia Channels API
  version: 1.0.0
extends: openapi/wistia-channels-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: 8
- target: $.paths['/channels'].get
  update:
    x-apievangelist-phrasing:
      intent: List my channels
      effect: read
      questions:
      - What channels do I have in my account?
      - Can I fetch several specific channels at once by their hashed IDs?
      instructions:
      - text: List all my channels.
      - text: Fetch channels {hashed_ids} in one request.
        slots:
          hashed_ids: query.hashed_ids[]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/channels'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a channel
      effect: write
      questions:
      - Can I create a new channel for my videos?
      - Is it possible to make a new channel a podcast when I create it?
      instructions:
      - text: Create a channel named {name}.
        slots:
          name: requestBody.name
      - text: Create podcast-enabled channel {name} with description {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/channels/{channelHashedId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a channel
      effect: read
      questions:
      - What settings and details does one of my channels have?
      - Can I look up a single channel by its ID?
      instructions:
      - text: Show channel {channel}.
        slots:
          channel: path.channelHashedId
      - text: Get the details of channel {channel}.
        slots:
          channel: path.channelHashedId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/channels/{channelHashedId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a channel
      effect: write
      questions:
      - How do I rename or edit one of my channels?
      - Can I change a channel's details after creating it?
      instructions:
      - text: Update channel {channel}.
        slots:
          channel: path.channelHashedId
      - text: Edit the settings of channel {channel}.
        slots:
          channel: path.channelHashedId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/channels/{channelHashedId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a channel
      effect: destructive
      questions:
      - How do I permanently remove a channel?
      - Can I delete a channel I no longer use?
      instructions:
      - text: Delete channel {channel}.
        slots:
          channel: path.channelHashedId
      - text: Remove channel {channel} from my account.
        slots:
          channel: path.channelHashedId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/channels/{hashedId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a channel via the legacy route
      effect: read
      questions:
      - Does the older hashed-ID channel route still return a single channel?
      - Which legacy endpoint reads one channel by hashed ID?
      instructions:
      - text: Fetch channel {channel} through the legacy hashedId route.
        slots:
          channel: path.hashedId
      - text: Read hashed-ID channel {channel} using the older show endpoint.
        slots:
          channel: path.hashedId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/channels/{hashedId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a channel via the legacy route
      effect: write
      questions:
      - Can I still update a channel through the legacy hashed-ID route?
      - Which older endpoint edits one channel by hashed ID?
      instructions:
      - text: Update channel {channel} through the legacy hashedId route.
        slots:
          channel: path.hashedId
      - text: Edit hashed-ID channel {channel} using the older update endpoint.
        slots:
          channel: path.hashedId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/channels/{hashedId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a channel via the legacy route
      effect: destructive
      questions:
      - Can the legacy hashed-ID route still delete a channel?
      - Which older endpoint permanently removes a channel by its hashed ID?
      instructions:
      - text: Delete channel {channel} through the legacy hashedId route.
        slots:
          channel: path.hashedId
      - text: Permanently remove hashed-ID channel {channel} with the older delete endpoint.
        slots:
          channel: path.hashedId
      method: generated
      generated: '2026-10-01'