Gumlet · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gumlet Video Profiles API

6 actions 6 updates phrasing extends openapi/gumlet-video-profiles-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/profiles'].get
$.paths['/video/profiles'].post
$.paths['/video/profiles/{profile_id}'].get
$.paths['/video/profiles/{profile_id}'].post
$.paths['/video/profiles/{profile_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 Video Profiles API
  version: 1.0.0
extends: openapi/gumlet-video-profiles-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/profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List video processing profiles
      effect: read
      questions:
      - What video profiles have I already created?
      - Can I page through my saved encoding presets?
      instructions:
      - text: List my video profiles.
      - text: Show {size} video profiles from offset {offset}.
        slots:
          size: query.size
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a reusable video profile
      effect: write
      questions:
      - Can I save a set of encoding settings to reuse across many videos?
      - How do I create a preset that always enables DRM or MP4 downloads?
      instructions:
      - text: Create video profile {name} with format {format}.
        slots:
          name: requestBody.name
          format: requestBody.format
      - text: Create a {format} profile called {name} at resolution {resolution}.
        slots:
          format: requestBody.format
          name: requestBody.name
          resolution: requestBody.resolution
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/profiles/{profile_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a video profile's settings
      effect: read
      questions:
      - What settings are inside a particular video profile?
      - Can I view one profile's format and resolution?
      instructions:
      - text: Get video profile {profile_id}.
        slots:
          profile_id: path.profile_id
      - text: Show the settings of profile {profile_id}.
        slots:
          profile_id: path.profile_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/profiles/{profile_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a video profile's settings
      effect: write
      questions:
      - Can I change the format or resolution in an existing profile?
      - Is it possible to turn on auto-generated chapters in a profile?
      instructions:
      - text: Rename video profile {profile_id} to {name}.
        slots:
          profile_id: path.profile_id
          name: requestBody.name
      - text: Set the resolution of profile {profile_id} to {resolution}.
        slots:
          profile_id: path.profile_id
          resolution: requestBody.resolution
      - text: Set chapter generation to {generate_chapters} on profile {profile_id}.
        slots:
          generate_chapters: requestBody.generate_chapters
          profile_id: path.profile_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/profiles/{profile_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a video profile
      effect: destructive
      questions:
      - Will deleting a profile affect videos already created with it?
      - Can I remove a video profile I no longer use?
      instructions:
      - text: Delete video profile {profile_id}.
        slots:
          profile_id: path.profile_id
      - text: Remove encoding profile {profile_id}.
        slots:
          profile_id: path.profile_id
      method: generated
      generated: '2026-10-01'