# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DocuSign REST Workspace Items API
  version: 1.0.0
extends: openapi/docusign-workspaceitems-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['/v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List the contents of a workspace folder
      effect: read
      questions:
      - What files and subfolders are in a workspace folder?
      - Can I include thumbnails or user details when browsing a workspace folder?
      instructions:
      - text: List the contents of folder {folder} in workspace {workspace} for account {account}.
        slots:
          folder: path.folderId
          workspace: path.workspaceId
          account: path.accountId
      - text: Show files and subfolders of folder {folder} in workspace {workspace} with thumbnails.
        slots:
          folder: path.folderId
          workspace: path.workspaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete files or folders from a workspace
      effect: destructive
      questions:
      - Can I delete several workspace files and folders at once?
      - How do I clean out items from a workspace folder?
      instructions:
      - text: Delete items {items} from folder {folder} in workspace {workspace} for account {account}.
        slots:
          items: requestBody.items
          folder: path.folderId
          workspace: path.workspaceId
          account: path.accountId
      - text: Remove workspace items {items} from folder {folder}.
        slots:
          items: requestBody.items
          folder: path.folderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file to a workspace folder
      effect: write
      questions:
      - How do I upload a new file into a workspace folder?
      - Can I add files to the root of a shared workspace?
      instructions:
      - text: Upload a file to folder {folder} in workspace {workspace} for account {account}.
        slots:
          folder: path.folderId
          workspace: path.workspaceId
          account: path.accountId
      - text: Create a new workspace file in folder {folder} of workspace {workspace}.
        slots:
          folder: path.folderId
          workspace: path.workspaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a workspace file
      effect: read
      questions:
      - Can I download the binary of a file stored in a workspace?
      - Is it possible to get a PDF version of a workspace file?
      instructions:
      - text: Download file {file} from folder {folder} in workspace {workspace} for account {account}.
        slots:
          file: path.fileId
          folder: path.folderId
          workspace: path.workspaceId
          account: path.accountId
      - text: Get workspace file {file} as a PDF.
        slots:
          file: path.fileId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a workspace file's metadata
      effect: write
      questions:
      - Can I rename or change the metadata of a workspace file?
      - Where do I edit details on a file already in a workspace?
      instructions:
      - text: Update metadata of file {file} in folder {folder} of workspace {workspace} for account {account}.
        slots:
          file: path.fileId
          folder: path.folderId
          workspace: path.workspaceId
          account: path.accountId
      - text: Edit the details of workspace file {file}.
        slots:
          file: path.fileId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages'].get
  update:
    x-apievangelist-phrasing:
      intent: Render a workspace file as page images
      effect: read
      questions:
      - Can I get a workspace file as rasterized page images for a preview?
      - What resolution or maximum size can the page images use?
      instructions:
      - text: Get page images of file {file} in folder {folder} of workspace {workspace} for account {account}.
        slots:
          file: path.fileId
          folder: path.folderId
          workspace: path.workspaceId
          account: path.accountId
      - text: Render workspace file {file} as pages at {dpi} dpi.
        slots:
          file: path.fileId
          dpi: query.dpi
      method: generated
      generated: '2026-10-01'