Wistia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Data Channel Collaborators API

4 actions 4 updates phrasing extends openapi/wistia-channel-collaborators-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 4

$.info

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

$.paths['/channels/{channelHashedId}/collaborators'].post

$.paths['/channels/{channelHashedId}/collaborators/{id}'].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 Data Channel Collaborators API
  version: 1.0.0
extends: openapi/wistia-channel-collaborators-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: 3
- target: $.paths['/channels/{channelHashedId}/collaborators'].get
  update:
    x-apievangelist-phrasing:
      intent: List a channel's collaborators
      effect: read
      questions:
      - Who has been given access to collaborate on this channel?
      - Which contacts and contact groups can work on my Wistia channel?
      instructions:
      - text: List the collaborators on channel {channelHashedId}.
        slots:
          channelHashedId: path.channelHashedId
      - text: Show who can access channel {channelHashedId}, {per_page} per page.
        slots:
          channelHashedId: path.channelHashedId
          per_page: query.per_page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/channels/{channelHashedId}/collaborators'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a collaborator to a channel
      effect: write
      questions:
      - How do I invite someone by email to collaborate on a channel?
      - Can I set a collaborator's role when adding them to a channel?
      instructions:
      - text: Invite {email} to channel {channelHashedId} as {role}.
        slots:
          email: requestBody.email
          channelHashedId: path.channelHashedId
          role: requestBody.role
      - text: Add {email} as a {role} collaborator on my channel {channelHashedId}.
        slots:
          email: requestBody.email
          role: requestBody.role
          channelHashedId: path.channelHashedId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/channels/{channelHashedId}/collaborators/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a collaborator from a channel
      effect: destructive
      questions:
      - How do I revoke a collaborator's access to a channel?
      - Can I take someone off a channel they were invited to?
      instructions:
      - text: Remove collaborator {id} from channel {channelHashedId}.
        slots:
          id: path.id
          channelHashedId: path.channelHashedId
      - text: Revoke channel {channelHashedId} access for collaborator {id}.
        slots:
          channelHashedId: path.channelHashedId
          id: path.id
      method: generated
      generated: '2026-10-01'