# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Gotowebinar Registrants API
  version: 1.0.0
extends: openapi/gotowebinar-registrants-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: 5
- target: $.paths['/organizers/{organizerKey}/webinars/{webinarKey}/registrants'].get
  update:
    x-apievangelist-phrasing:
      intent: List everyone registered for a webinar
      effect: read
      questions:
      - Who has signed up for my upcoming GoTo Webinar event?
      - Can I see which registrants are still waiting for approval or were denied?
      - Is the registrant list paginated if a webinar has thousands of signups?
      instructions:
      - text: List the registrants for webinar {webinarKey} of organizer {organizerKey}.
        slots:
          webinarKey: path.webinarKey
          organizerKey: path.organizerKey
      - text: Get page {page} of webinar {webinarKey}'s registrants, {limit} per page.
        slots:
          page: query.page
          webinarKey: path.webinarKey
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizers/{organizerKey}/webinars/{webinarKey}/registrants'].post
  update:
    x-apievangelist-phrasing:
      intent: Register someone for a webinar
      effect: write
      questions:
      - How do I sign a person up for a webinar and get their join link?
      - Can I record which campaign a registration came from?
      - Will the registrant get a confirmation email when I add them?
      instructions:
      - text: Register {firstName} {lastName} ({email}) for webinar {webinarKey} of organizer {organizerKey}.
        slots:
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          email: requestBody.email
          webinarKey: path.webinarKey
          organizerKey: path.organizerKey
      - text: Sign up {email} ({firstName} {lastName}) for webinar {webinarKey}, crediting source {source}.
        slots:
          email: requestBody.email
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          webinarKey: path.webinarKey
          source: requestBody.source
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizers/{organizerKey}/webinars/{webinarKey}/registrants/{registrantKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one registrant's full registration
      effect: read
      questions:
      - What did a specific person fill in when they registered for my webinar?
      - Where can I see every field a single registrant submitted, including custom questions?
      instructions:
      - text: Get registrant {registrantKey} for webinar {webinarKey} of organizer {organizerKey}.
        slots:
          registrantKey: path.registrantKey
          webinarKey: path.webinarKey
          organizerKey: path.organizerKey
      - text: Show the full registration details of registrant {registrantKey}.
        slots:
          registrantKey: path.registrantKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizers/{organizerKey}/webinars/{webinarKey}/registrants/{registrantKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel someone's webinar registration
      effect: destructive
      questions:
      - How do I remove a person from the registration list of an upcoming webinar?
      - Can I delete a registrant from a webinar that has already happened?
      instructions:
      - text: Remove registrant {registrantKey} from webinar {webinarKey} of organizer {organizerKey}.
        slots:
          registrantKey: path.registrantKey
          webinarKey: path.webinarKey
          organizerKey: path.organizerKey
      - text: Unregister {registrantKey} from upcoming webinar {webinarKey}.
        slots:
          registrantKey: path.registrantKey
          webinarKey: path.webinarKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizers/{organizerKey}/webinars/{webinarKey}/registrants/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webinar's registration form fields
      effect: read
      questions:
      - Which fields and custom questions does my webinar's registration form require?
      - What values are allowed for the custom registration questions before I register someone?
      instructions:
      - text: Get the registration fields for webinar {webinarKey} of organizer {organizerKey}.
        slots:
          webinarKey: path.webinarKey
          organizerKey: path.organizerKey
      - text: List the required and optional sign-up questions on webinar {webinarKey}.
        slots:
          webinarKey: path.webinarKey
      method: generated
      generated: '2026-10-01'