# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Wistia Subfolders API
  version: 1.0.0
extends: openapi/wistia-sub-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: 11
- target: $.paths['/folders/{folderId}/subfolders'].get
  update:
    x-apievangelist-phrasing:
      intent: List subfolders in a folder
      effect: read
      questions:
      - What subfolders are inside this folder?
      - Can I sort the subfolders of a folder?
      instructions:
      - text: List the subfolders in folder {folderId}.
        slots:
          folderId: path.folderId
      - text: Show subfolders of folder {folderId} sorted by {sort_by}.
        slots:
          folderId: path.folderId
          sort_by: query.sort_by
      method: generated
      generated: '2026-10-01'
- target: $.paths['/folders/{folderId}/subfolders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a subfolder in a folder
      effect: write
      questions:
      - How do I add a subfolder inside a folder?
      - Where does a new subfolder go in a folder's ordering?
      instructions:
      - text: Create a subfolder named {name} in folder {folderId}.
        slots:
          name: requestBody.name
          folderId: path.folderId
      - text: Add subfolder {name} to folder {folderId} with description {description}.
        slots:
          name: requestBody.name
          folderId: path.folderId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/folders/{folderId}/subfolders/{subfolderId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a subfolder in a folder
      effect: read
      questions:
      - How do I see a subfolder of a folder and the media in it?
      - Can I get a folder's subfolder description as plain text?
      instructions:
      - text: Show subfolder {subfolderId} in folder {folderId}.
        slots:
          subfolderId: path.subfolderId
          folderId: path.folderId
      - text: List the media in subfolder {subfolderId} of folder {folderId}.
        slots:
          subfolderId: path.subfolderId
          folderId: path.folderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/folders/{folderId}/subfolders/{subfolderId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or describe a subfolder in a folder
      effect: write
      questions:
      - How do I rename a subfolder inside a folder?
      - Can I change a folder's subfolder description?
      instructions:
      - text: Rename subfolder {subfolderId} in folder {folderId} to {name}.
        slots:
          subfolderId: path.subfolderId
          folderId: path.folderId
          name: requestBody.name
      - text: Set the description of folder {folderId} subfolder {subfolderId} to {description}.
        slots:
          folderId: path.folderId
          subfolderId: path.subfolderId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/folders/{folderId}/subfolders/{subfolderId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one subfolder from a folder
      effect: destructive
      questions:
      - What happens to the media when I delete a single subfolder in a folder?
      - How do I delete one subfolder and keep its videos in the folder?
      instructions:
      - text: Delete subfolder {subfolderId} from folder {folderId}.
        slots:
          subfolderId: path.subfolderId
          folderId: path.folderId
      - text: Remove subfolder {subfolderId} and move its media to the root of folder {folderId}.
        slots:
          subfolderId: path.subfolderId
          folderId: path.folderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/folders/{folderId}/subfolders/bulk_delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several subfolders at once
      effect: destructive
      questions:
      - How do I delete many subfolders in one request?
      - Is the media in bulk-deleted subfolders recoverable?
      instructions:
      - text: Bulk delete subfolders {hashed_ids} in folder {folderId}.
        slots:
          hashed_ids: requestBody.hashed_ids
          folderId: path.folderId
      - text: 'Delete all of these subfolders from folder {folderId} at once: {hashed_ids}.'
        slots:
          folderId: path.folderId
          hashed_ids: requestBody.hashed_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/subfolders'].get
  update:
    x-apievangelist-phrasing:
      intent: List subfolders in a project
      effect: read
      questions:
      - What subfolders does this project contain?
      - Can I page through a project's subfolders?
      instructions:
      - text: List the subfolders in project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show subfolders of project {projectId}, {per_page} per page.
        slots:
          projectId: path.projectId
          per_page: query.per_page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/subfolders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a subfolder in a project
      effect: write
      questions:
      - How do I add a subfolder inside a project?
      - Can I give a new project subfolder a description?
      instructions:
      - text: Create a subfolder named {name} in project {projectId}.
        slots:
          name: requestBody.name
          projectId: path.projectId
      - text: Add subfolder {name} to project {projectId} described as {description}.
        slots:
          name: requestBody.name
          projectId: path.projectId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/subfolders/{subfolderId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a subfolder in a project
      effect: read
      questions:
      - How do I see a project's subfolder and the media files in it?
      - Which format can a project subfolder's description come back in?
      instructions:
      - text: Show subfolder {subfolderId} in project {projectId}.
        slots:
          subfolderId: path.subfolderId
          projectId: path.projectId
      - text: List the media in subfolder {subfolderId} of project {projectId}.
        slots:
          subfolderId: path.subfolderId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/subfolders/{subfolderId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or describe a subfolder in a project
      effect: write
      questions:
      - How do I rename a subfolder inside a project?
      - Can I update the description of a project's subfolder?
      instructions:
      - text: Rename subfolder {subfolderId} in project {projectId} to {name}.
        slots:
          subfolderId: path.subfolderId
          projectId: path.projectId
          name: requestBody.name
      - text: Set the description of project {projectId} subfolder {subfolderId} to {description}.
        slots:
          projectId: path.projectId
          subfolderId: path.subfolderId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/subfolders/{subfolderId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a subfolder from a project
      effect: destructive
      questions:
      - What happens to the media when I delete a subfolder from a project?
      - How do I delete a project subfolder and keep its videos?
      instructions:
      - text: Delete subfolder {subfolderId} from project {projectId}.
        slots:
          subfolderId: path.subfolderId
          projectId: path.projectId
      - text: Remove subfolder {subfolderId} and move its media to the root of project {projectId}.
        slots:
          subfolderId: path.subfolderId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'