Wistia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Data Webinar Collaborators API

4 actions 4 updates phrasing extends openapi/wistia-webinar-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['/webinars/{webinarId}/collaborators'].get
$.paths['/webinars/{webinarId}/collaborators'].post
$.paths['/webinars/{webinarId}/collaborators/{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 Data Webinar Collaborators API
  version: 1.0.0
extends: openapi/wistia-webinar-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['/webinars/{webinarId}/collaborators'].get
  update:
    x-apievangelist-phrasing:
      intent: List a webinar's producers
      effect: read
      questions:
      - Who has producer access to this webinar?
      - Which contacts and groups can help run my webinar?
      instructions:
      - text: List the collaborators on webinar {webinarId}.
        slots:
          webinarId: path.webinarId
      - text: Show the producers of webinar {webinarId}.
        slots:
          webinarId: path.webinarId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webinars/{webinarId}/collaborators'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a producer to a webinar
      effect: write
      questions:
      - How do I add someone as a producer on a webinar?
      - Does inviting a webinar collaborator create a contact if none exists?
      instructions:
      - text: Invite {email} as a producer on webinar {webinarId}.
        slots:
          email: requestBody.email
          webinarId: path.webinarId
      - text: Add {email} to webinar {webinarId} as a collaborator.
        slots:
          email: requestBody.email
          webinarId: path.webinarId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webinars/{webinarId}/collaborators/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a producer from a webinar
      effect: destructive
      questions:
      - How do I take away someone's producer access to a webinar?
      - Can I remove a collaborator from a webinar?
      instructions:
      - text: Remove collaborator {id} from webinar {webinarId}.
        slots:
          id: path.id
          webinarId: path.webinarId
      - text: Revoke producer access on webinar {webinarId} for {id}.
        slots:
          webinarId: path.webinarId
          id: path.id
      method: generated
      generated: '2026-10-01'