Wistia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Data Webinar Registrations API

3 actions 3 updates phrasing extends openapi/wistia-webinar-registrations-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 3

$.info
$.paths['/webinars/{webinarId}/registrations'].get
$.paths['/webinars/{webinarId}/registrations'].post

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 Registrations API
  version: 1.0.0
extends: openapi/wistia-webinar-registrations-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: 2
- target: $.paths['/webinars/{webinarId}/registrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List a webinar's registrations
      effect: read
      questions:
      - Who has registered for one of my webinars?
      - Can I filter webinar registrants by whether they attended?
      instructions:
      - text: List registrations for webinar {webinar}.
        slots:
          webinar: path.webinarId
      - text: List registrants for webinar {webinar} filtered by attendance {attendance}.
        slots:
          webinar: path.webinarId
          attendance: query.attendance
      - text: Look up registrations for {emails} on webinar {webinar}.
        slots:
          emails: query.emails[]
          webinar: path.webinarId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webinars/{webinarId}/registrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a person for a webinar
      effect: write
      questions:
      - Can I register someone for a webinar and get their personal join link?
      - What details do I need to sign a person up for a webinar?
      instructions:
      - text: Register {email} ({first_name} {last_name}) for webinar {webinar}.
        slots:
          email: requestBody.email
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          webinar: path.webinarId
      - text: Sign up {first_name} {last_name} at {email} for webinar {webinar}.
        slots:
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          email: requestBody.email
          webinar: path.webinarId
      method: generated
      generated: '2026-10-01'