# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Gumlet Folders API
  version: 1.0.0
extends: openapi/gumlet-folders-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: 6
- target: $.paths['/video/workspaces/{workspace_id}/folders'].get
  update:
    x-apievangelist-phrasing:
      intent: List folders in a video workspace
      effect: read
      questions:
      - What folders exist in my video workspace?
      - Can I see only the subfolders inside one parent folder?
      instructions:
      - text: List folders in workspace {workspace_id}.
        slots:
          workspace_id: path.workspace_id
      - text: List the subfolders of {parent_id} in workspace {workspace_id}.
        slots:
          parent_id: query.parent_id
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/workspaces/{workspace_id}/folders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a folder in a video workspace
      effect: write
      questions:
      - How do I organize my videos into a new folder?
      - Can I create a nested folder inside an existing one?
      instructions:
      - text: Create a folder named {name} in workspace {workspace_id}.
        slots:
          name: requestBody.name
          workspace_id: path.workspace_id
      - text: Create folder {name} nested under {parent_id} in workspace {workspace_id}.
        slots:
          name: requestBody.name
          parent_id: requestBody.parent_id
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/workspaces/{workspace_id}/folders/{folder_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a folder's details
      effect: read
      questions:
      - What are the details of one specific folder in my workspace?
      - Can I look up a single folder by its id?
      instructions:
      - text: Get folder {folder_id} in workspace {workspace_id}.
        slots:
          folder_id: path.folder_id
          workspace_id: path.workspace_id
      - text: Look up folder {folder_id} from workspace {workspace_id}.
        slots:
          folder_id: path.folder_id
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/workspaces/{workspace_id}/folders/{folder_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename, move or fill a folder
      effect: write
      questions:
      - Can I rename a folder or move it under a different parent?
      - How can I move existing videos into a folder?
      instructions:
      - text: Rename folder {folder_id} in workspace {workspace_id} to {name}.
        slots:
          folder_id: path.folder_id
          workspace_id: path.workspace_id
          name: requestBody.name
      - text: Move videos {asset_ids} into folder {folder_id} in workspace {workspace_id}.
        slots:
          asset_ids: requestBody.asset_ids
          folder_id: path.folder_id
          workspace_id: path.workspace_id
      - text: Move folder {folder_id} under parent folder {parent_id} in workspace {workspace_id}.
        slots:
          folder_id: path.folder_id
          parent_id: requestBody.parent_id
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/workspaces/{workspace_id}/folders/{folder_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a folder and its contents
      effect: destructive
      questions:
      - What happens to the videos and subfolders when I delete a folder?
      - Can I delete a whole folder tree from my workspace?
      instructions:
      - text: Delete folder {folder_id} from workspace {workspace_id}.
        slots:
          folder_id: path.folder_id
          workspace_id: path.workspace_id
      - text: Remove folder {folder_id} along with everything nested in it, in workspace {workspace_id}.
        slots:
          folder_id: path.folder_id
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/video/workspaces/{workspace_id}/remove-assets-from-folder'].post
  update:
    x-apievangelist-phrasing:
      intent: Take videos out of their folder
      effect: write
      questions:
      - Can I pull videos out of a folder without deleting them?
      - How do I unassign several assets from their current folder?
      instructions:
      - text: Remove assets {asset_ids} from their folder in workspace {workspace_id}.
        slots:
          asset_ids: requestBody.asset_ids
          workspace_id: path.workspace_id
      - text: Unfile videos {asset_ids} so they sit at the root of workspace {workspace_id}.
        slots:
          asset_ids: requestBody.asset_ids
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-10-01'