# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Sigma Computing Files API
  version: 1.0.0
extends: openapi/sigma-computing-files-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v2/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List documents and folders
      effect: read
      questions:
      - What workbooks and folders can I see under a given folder?
      - Can I list only data models or only workbooks from my files?
      - Why don't some documents I see in the UI appear in the file list?
      instructions:
      - text: List the documents and folders inside parent {parentId}.
        slots:
          parentId: query.parentId
      - text: Search my files for {name} of type {typeFilters}.
        slots:
          name: query.name
          typeFilters: query.typeFilters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/files'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an empty folder, workbook or report
      effect: write
      questions:
      - How do I create a new folder in Sigma through the API?
      - Can I create an empty workspace, folder or report on behalf of another user?
      instructions:
      - text: Create a new empty folder in Sigma.
      - text: Create a blank report inside one of my folders.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/files/{inodeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a document or folder
      effect: read
      questions:
      - How do I look up a workbook, report or folder by its file ID?
      - What information is returned about a single Sigma document?
      instructions:
      - text: Get file {inodeId}.
        slots:
          inodeId: path.inodeId
      - text: Show the details of document {inodeId}.
        slots:
          inodeId: path.inodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/files/{inodeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a document or folder
      effect: destructive
      questions:
      - How do I delete a folder or workbook by its file ID?
      - Can I delete a data model through the files API?
      instructions:
      - text: Delete file {inodeId}.
        slots:
          inodeId: path.inodeId
      - text: Remove the folder or document {inodeId}.
        slots:
          inodeId: path.inodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/files/{inodeId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename, move or restore a document
      effect: write
      questions:
      - How do I move a workbook into a different folder?
      - Can I restore a deleted document or change its owner?
      instructions:
      - text: Move file {inodeId} into folder {parentId}.
        slots:
          inodeId: path.inodeId
          parentId: requestBody.parentId
      - text: Rename document {inodeId} to {name}.
        slots:
          inodeId: path.inodeId
          name: requestBody.name
      - text: Transfer ownership of file {inodeId} to {ownerId}.
        slots:
          inodeId: path.inodeId
          ownerId: requestBody.ownerId
      method: generated
      generated: '2026-09-26'