Gumlet · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gumlet Live Stream Workspaces API

5 actions 5 updates phrasing extends openapi/gumlet-live-stream-workspaces-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['/video/sources/live'].get
$.paths['/video/sources/live'].post
$.paths['/video/sources/live/{live_workspace_id}'].post
$.paths['/video/sources/live/{live_workspace_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 Gumlet Live Stream Workspaces API
  version: 1.0.0
extends: openapi/gumlet-live-stream-workspaces-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['/video/sources/live'].get
  update:
    x-apievangelist-phrasing:
      intent: List live stream workspaces
      effect: read
      questions:
      - What live stream workspaces do I have?
      - Where do I find the id of my live streaming workspace?
      instructions:
      - text: List my live stream workspaces.
      - text: Show all workspaces used for live streaming.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/sources/live'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a live stream workspace
      effect: write
      questions:
      - How do I set up a separate workspace for live streaming?
      - Can I create another live workspace for a different team?
      instructions:
      - text: Create a live stream workspace named {name}.
        slots:
          name: requestBody.name
      - text: Set up a new live workspace called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/sources/live/{live_workspace_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a live stream workspace
      effect: write
      questions:
      - Can I rename a live stream workspace?
      - Is it possible to link a live workspace to a video workspace for recordings?
      instructions:
      - text: Rename live workspace {live_workspace_id} to {name}.
        slots:
          live_workspace_id: path.live_workspace_id
          name: requestBody.name
      - text: Connect live workspace {live_workspace_id} to video workspace {video_source_id}.
        slots:
          live_workspace_id: path.live_workspace_id
          video_source_id: requestBody.video_source_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/sources/live/{live_workspace_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a live stream workspace
      effect: destructive
      questions:
      - Can I delete a live streaming workspace I no longer need?
      - What's the way to remove an unused live workspace?
      instructions:
      - text: Delete live workspace {live_workspace_id}.
        slots:
          live_workspace_id: path.live_workspace_id
      - text: Remove the live streaming workspace {live_workspace_id}.
        slots:
          live_workspace_id: path.live_workspace_id
      method: generated
      generated: '2026-10-01'