Gumlet · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gumlet Video Workspaces API

6 actions 6 updates phrasing extends openapi/gumlet-video-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 6

$.info

$.paths['/video/workspaces'].get

$.paths['/video/workspaces'].post

$.paths['/video/workspaces/{workspace_id}'].get

$.paths['/video/workspaces/{workspace_id}'].post

$.paths['/video/workspaces/{workspace_id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Gumlet Video Workspaces API
  version: 1.0.0
extends: openapi/gumlet-video-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: 5
- target: $.paths['/video/workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List video workspaces
      effect: read
      questions:
      - What video workspaces can my API token access?
      - Can I page through all my video workspaces?
      instructions:
      - text: List my video workspaces.
      - text: Show {size} video workspaces from offset {offset}.
        slots:
          size: query.size
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/workspaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a video workspace
      effect: write
      questions:
      - How do I create a separate video workspace for another team?
      - Can I connect my own storage bucket as a new video workspace?
      instructions:
      - text: Create a {type} video workspace named {name}.
        slots:
          type: requestBody.type
          name: requestBody.name
      - text: Create video workspace {name} of type {type} using default profile {default_profile_id}.
        slots:
          name: requestBody.name
          type: requestBody.type
          default_profile_id: requestBody.default_profile_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/workspaces/{workspace_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a video workspace's settings
      effect: read
      questions:
      - What settings does a specific video workspace have?
      - Can I see the player and protection config of one workspace?
      instructions:
      - text: Get video workspace {workspace_id}.
        slots:
          workspace_id: path.workspace_id
      - text: Show the configuration of workspace {workspace_id}.
        slots:
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/workspaces/{workspace_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a video workspace's settings
      effect: write
      questions:
      - Can I change the default profile or player settings on a workspace?
      - Is it possible to rename a video workspace?
      instructions:
      - text: Rename video workspace {workspace_id} to {name}.
        slots:
          workspace_id: path.workspace_id
          name: requestBody.name
      - text: Set the default profile of workspace {workspace_id} to {default_profile_id}.
        slots:
          workspace_id: path.workspace_id
          default_profile_id: requestBody.default_profile_id
      - text: Update the player config of workspace {workspace_id} to {player_config}.
        slots:
          workspace_id: path.workspace_id
          player_config: requestBody.player_config
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/workspaces/{workspace_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a video workspace
      effect: destructive
      questions:
      - Does deleting a video workspace remove all of its videos too?
      - Can I permanently delete a workspace I no longer use?
      instructions:
      - text: Delete video workspace {workspace_id}.
        slots:
          workspace_id: path.workspace_id
      - text: Remove workspace {workspace_id} and all its videos.
        slots:
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-10-01'