Gumlet · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gumlet Video Playlists API

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

$.info
$.paths['/video/playlist'].get
$.paths['/video/playlist'].post
$.paths['/video/playlist/{playlist_id}/asset'].post
$.paths['/video/playlist/{playlist_id}/asset'].delete
$.paths['/video/playlist/{playlist_id}'].post
$.paths['/video/playlist/{playlist_id}'].delete
$.paths['/video/playlist/{playlist_id}/assets'].get
$.paths['/video/playlists/{playlist_id}/reorder'].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 Gumlet Video Playlists API
  version: 1.0.0
extends: openapi/gumlet-video-playlists-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: 8
- target: $.paths['/video/playlist'].get
  update:
    x-apievangelist-phrasing:
      intent: List playlists in a workspace
      effect: read
      questions:
      - What playlists do I have in my video workspace?
      - Can I list playlists for just one workspace?
      instructions:
      - text: List all my playlists.
      - text: List playlists in workspace {collection_id}.
        slots:
          collection_id: query.collection_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/playlist'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a playlist
      effect: write
      questions:
      - How do I group videos into a new playlist?
      - Can I add a description when creating a playlist?
      instructions:
      - text: Create a playlist called {title} in workspace {collection_id}.
        slots:
          title: requestBody.title
          collection_id: requestBody.collection_id
      - text: Make playlist {title} in {collection_id} with description {description}.
        slots:
          title: requestBody.title
          collection_id: requestBody.collection_id
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/playlist/{playlist_id}/asset'].post
  update:
    x-apievangelist-phrasing:
      intent: Add videos to a playlist
      effect: write
      questions:
      - Can I add several videos to a playlist in one call?
      - How do I put a video into an existing playlist?
      instructions:
      - text: Add videos {asset_list} to playlist {playlist_id}.
        slots:
          asset_list: requestBody.asset_list
          playlist_id: path.playlist_id
      - text: Put {asset_list} into playlist {playlist_id}.
        slots:
          asset_list: requestBody.asset_list
          playlist_id: path.playlist_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/playlist/{playlist_id}/asset'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove videos from a playlist
      effect: destructive
      questions:
      - Can I take a video out of a playlist without deleting the video?
      - Is there a way to remove several videos from one playlist?
      instructions:
      - text: Remove videos {delete_list} from playlist {playlist_id}.
        slots:
          delete_list: requestBody.delete_list
          playlist_id: path.playlist_id
      - text: Take {delete_list} out of playlist {playlist_id}.
        slots:
          delete_list: requestBody.delete_list
          playlist_id: path.playlist_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/playlist/{playlist_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a playlist's details or visibility
      effect: write
      questions:
      - Can I rename a playlist or hide it from my channel page?
      - How do I change where a playlist appears on the channel?
      instructions:
      - text: Rename playlist {playlist_id} to {title}.
        slots:
          playlist_id: path.playlist_id
          title: requestBody.title
      - text: Set channel visibility of playlist {playlist_id} to {channel_visibility}.
        slots:
          playlist_id: path.playlist_id
          channel_visibility: requestBody.channel_visibility
      - text: Move playlist {playlist_id} to position {position} on the channel page.
        slots:
          playlist_id: path.playlist_id
          position: requestBody.position
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/playlist/{playlist_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a playlist
      effect: destructive
      questions:
      - Can I delete a playlist I no longer need?
      - What's the call to remove an entire playlist?
      instructions:
      - text: Delete playlist {playlist_id}.
        slots:
          playlist_id: path.playlist_id
      - text: Remove the whole playlist {playlist_id}.
        slots:
          playlist_id: path.playlist_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/playlist/{playlist_id}/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List the videos in a playlist
      effect: read
      questions:
      - Which videos are inside a given playlist?
      - Can I get a playlist's videos sorted by date or title?
      instructions:
      - text: List the videos in playlist {playlist_id}.
        slots:
          playlist_id: path.playlist_id
      - text: Show playlist {playlist_id} videos sorted by {sort_by} {sort_order}.
        slots:
          playlist_id: path.playlist_id
          sort_by: query.sort_by
          sort_order: query.sort_order
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/playlists/{playlist_id}/reorder'].post
  update:
    x-apievangelist-phrasing:
      intent: Reorder the videos in a playlist
      effect: write
      questions:
      - Can I change the order videos play in within a playlist?
      - Is it possible to sort a playlist's videos by title or creation date?
      instructions:
      - text: Reorder the videos in playlist {playlist_id}.
        slots:
          playlist_id: path.playlist_id
      - text: Rearrange the sequence of videos within playlist {playlist_id}.
        slots:
          playlist_id: path.playlist_id
      method: generated
      generated: '2026-10-01'