Gumlet · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gumlet Channel Viewers API

5 actions 5 updates phrasing extends openapi/gumlet-channel-viewers-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Gumlet's API. It is a proposal applied on top of the contract, not a document Gumlet publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/channel/{video_workspace_id}/viewers/invite'].post
$.paths['/channel/{video_workspace_id}/viewers/remove'].post
$.paths['/channel/{video_workspace_id}/viewers/invite/csv'].post
$.paths['/channel/{workspace_id}/viewers'].get

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 Gumlet Channel Viewers API
  version: 1.0.0
extends: openapi/gumlet-channel-viewers-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: 4
- target: $.paths['/channel/{video_workspace_id}/viewers/invite'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite viewers to a members-only channel
      effect: write
      questions:
      - Can I give specific people access to my members-only video channel?
      - How do I invite a few viewers to a private channel without a CSV?
      instructions:
      - text: Invite {users} to channel {video_workspace_id}.
        slots:
          users: requestBody.users
          video_workspace_id: path.video_workspace_id
      - text: 'Add these viewers to members-only channel {video_workspace_id}: {users}.'
        slots:
          video_workspace_id: path.video_workspace_id
          users: requestBody.users
      method: generated
      generated: '2026-10-01'
- target: $.paths['/channel/{video_workspace_id}/viewers/remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove viewers from a channel
      effect: destructive
      questions:
      - How can I revoke a viewer's access to my channel by email?
      - Can I remove several channel members at once?
      instructions:
      - text: Remove {emails} from channel {video_workspace_id}.
        slots:
          emails: requestBody.emails
          video_workspace_id: path.video_workspace_id
      - text: Revoke channel {video_workspace_id} access for viewer emails {emails}.
        slots:
          video_workspace_id: path.video_workspace_id
          emails: requestBody.emails
      method: generated
      generated: '2026-10-01'
- target: $.paths['/channel/{video_workspace_id}/viewers/invite/csv'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk-invite channel viewers from a CSV
      effect: write
      questions:
      - Can I upload a spreadsheet of emails to invite viewers to my channel?
      - Is there a bulk CSV import for channel members?
      instructions:
      - text: Invite the viewers in {viewers_csv} to channel {video_workspace_id}.
        slots:
          viewers_csv: requestBody.viewers_csv
          video_workspace_id: path.video_workspace_id
      - text: Upload CSV file {viewers_csv} to bulk-invite viewers to {video_workspace_id}.
        slots:
          viewers_csv: requestBody.viewers_csv
          video_workspace_id: path.video_workspace_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/channel/{workspace_id}/viewers'].get
  update:
    x-apievangelist-phrasing:
      intent: List a channel's subscribers
      effect: read
      questions:
      - Who is subscribed to my video channel?
      - Can I page through a long list of channel subscribers?
      instructions:
      - text: List subscribers of channel {workspace_id}.
        slots:
          workspace_id: path.workspace_id
      - text: Show page {page_number} of subscribers for channel {workspace_id}, {page_size} per page.
        slots:
          page_number: query.page_number
          workspace_id: path.workspace_id
          page_size: query.page_size
      method: generated
      generated: '2026-10-01'