TextQL · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for TextQL Dataset Service API

15 actions 15 updates phrasing extends openapi/textql-datasetservice-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for TextQL's API. It is a proposal applied on top of the contract, not a document TextQL publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 15

$.info
$.paths['/textql.rpc.public.dataset.DatasetService/CreateFolder'].post
$.paths['/textql.rpc.public.dataset.DatasetService/CreatePowerBIDataset'].post
$.paths['/textql.rpc.public.dataset.DatasetService/CreateTableauDataset'].post
$.paths['/textql.rpc.public.dataset.DatasetService/CreateUploadPresignUrl'].post
$.paths['/textql.rpc.public.dataset.DatasetService/DeleteDataset'].post
$.paths['/textql.rpc.public.dataset.DatasetService/ExportDataset'].post
$.paths['/textql.rpc.public.dataset.DatasetService/GetDataset'].post
$.paths['/textql.rpc.public.dataset.DatasetService/GetDatasetStats'].post
$.paths['/textql.rpc.public.dataset.DatasetService/GetDatasetValues'].post
$.paths['/textql.rpc.public.dataset.DatasetService/GetDatasets'].post
$.paths['/textql.rpc.public.dataset.DatasetService/GetDatasetsByIds'].post
$.paths['/textql.rpc.public.dataset.DatasetService/GetFolders'].post
$.paths['/textql.rpc.public.dataset.DatasetService/ProcessUploadPresignUrl'].post
$.paths['/textql.rpc.public.dataset.DatasetService/UpdateDataset'].post

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 TextQL Dataset Service API
  version: 1.0.0
extends: openapi/textql-datasetservice-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: 14
- target: $.paths['/textql.rpc.public.dataset.DatasetService/CreateFolder'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a dataset folder
      effect: write
      questions:
      - How do I organize my datasets into folders?
      - Can I create a subfolder under an existing dataset path?
      instructions:
      - text: Create a dataset folder named {name}.
        slots:
          name: requestBody.name
      - text: Make folder {name} inside {parent_path}.
        slots:
          name: requestBody.name
          parent_path: requestBody.parentPath
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.dataset.DatasetService/CreatePowerBIDataset'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a dataset from Power BI
      effect: write
      questions:
      - Can I bring Power BI reports and datasets into TextQL as a dataset?
      - How do I build a dataset from a Power BI workspace?
      instructions:
      - text: Create a Power BI dataset named {name} from workspace {workspace} using connector {connector}.
        slots:
          name: requestBody.name
          workspace: requestBody.workspaceId
          connector: requestBody.connectorId
      - text: Import Power BI reports {reports} into a dataset {name} via connector {connector}.
        slots:
          reports: requestBody.reports
          name: requestBody.name
          connector: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.dataset.DatasetService/CreateTableauDataset'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a dataset from Tableau
      effect: write
      questions:
      - Can I turn Tableau views or datasources into a dataset?
      - How do I build a dataset from a Tableau project?
      instructions:
      - text: Create a Tableau dataset named {name} from project {project} using connector {connector}.
        slots:
          name: requestBody.name
          project: requestBody.projectId
          connector: requestBody.connectorId
      - text: Import Tableau views {views} into dataset {name} via connector {connector}.
        slots:
          views: requestBody.views
          name: requestBody.name
          connector: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.dataset.DatasetService/CreateUploadPresignUrl'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an upload URL for a new dataset file
      effect: write
      questions:
      - How do I upload a CSV or spreadsheet as a dataset?
      - Can an uploaded file be ephemeral and expire after some days?
      instructions:
      - text: Create an upload URL for file {file_name}.
        slots:
          file_name: requestBody.fileName
      - text: Get a presigned upload URL for {file_name} in folder {folder} that expires in {days} days.
        slots:
          file_name: requestBody.fileName
          folder: requestBody.folderPath
          days: requestBody.expiresInDays
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.dataset.DatasetService/DeleteDataset'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a dataset
      effect: destructive
      questions:
      - How do I delete a dataset I uploaded?
      - Is deleting a dataset a soft delete?
      instructions:
      - text: Delete dataset {dataset}.
        slots:
          dataset: requestBody.datasetId
      - text: Soft-delete the dataset {dataset}.
        slots:
          dataset: requestBody.datasetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.dataset.DatasetService/ExportDataset'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a dataset file
      effect: read
      questions:
      - How do I download a dataset in its original format?
      - Can I export a specific version of a dataset as CSV?
      instructions:
      - text: Export dataset {dataset}.
        slots:
          dataset: requestBody.datasetId
      - text: Export version {version} of dataset {dataset} as {format}.
        slots:
          version: requestBody.versionId
          dataset: requestBody.datasetId
          format: requestBody.preferredFormat
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.dataset.DatasetService/GetDataset'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a dataset's metadata
      effect: read
      questions:
      - How do I look up the metadata for one dataset?
      - What do I get back about a single dataset, without its rows?
      instructions:
      - text: Get dataset {dataset}.
        slots:
          dataset: requestBody.datasetId
      - text: Show metadata for dataset {dataset}.
        slots:
          dataset: requestBody.datasetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.dataset.DatasetService/GetDatasetStats'].post
  update:
    x-apievangelist-phrasing:
      intent: Get statistics for a dataset
      effect: read
      questions:
      - Can I see column statistics for a dataset?
      - How do I profile a particular version of a dataset?
      instructions:
      - text: Get stats for dataset {dataset}.
        slots:
          dataset: requestBody.datasetId
      - text: Profile version {version} of dataset {dataset}.
        slots:
          version: requestBody.versionId
          dataset: requestBody.datasetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.dataset.DatasetService/GetDatasetValues'].post
  update:
    x-apievangelist-phrasing:
      intent: Read rows from a dataset
      effect: read
      questions:
      - How do I read the actual rows inside a dataset?
      - Can I page through a specific sheet of an uploaded spreadsheet?
      instructions:
      - text: Show rows from dataset {dataset}.
        slots:
          dataset: requestBody.datasetId
      - text: Get page {page} of sheet {sheet} in dataset {dataset}, {limit} rows at a time.
        slots:
          page: requestBody.page
          sheet: requestBody.sheet
          dataset: requestBody.datasetId
          limit: requestBody.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.dataset.DatasetService/GetDatasets'].post
  update:
    x-apievangelist-phrasing:
      intent: Browse and search datasets
      effect: read
      questions:
      - Which datasets are in a given folder, including subfolders?
      - Can I search datasets by name and only see ones I own?
      instructions:
      - text: Search datasets for {search}.
        slots:
          search: requestBody.searchParam
      - text: List datasets in folder {path} including subfolders.
        slots:
          path: requestBody.path
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.dataset.DatasetService/GetDatasetsByIds'].post
  update:
    x-apievangelist-phrasing:
      intent: Get several datasets by ID
      effect: read
      questions:
      - Can I fetch metadata for a batch of datasets in one call?
      - How do I look up multiple datasets when I already have their IDs?
      instructions:
      - text: Get datasets {datasets}.
        slots:
          datasets: requestBody.datasetIds
      - text: Fetch metadata for the dataset IDs {datasets} together.
        slots:
          datasets: requestBody.datasetIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.dataset.DatasetService/GetFolders'].post
  update:
    x-apievangelist-phrasing:
      intent: List dataset folders
      effect: read
      questions:
      - What folders exist in my dataset library?
      - How do I list the folders under a given path?
      instructions:
      - text: List folders under {path}.
        slots:
          path: requestBody.path
      - text: Show the dataset folder tree at {path}.
        slots:
          path: requestBody.path
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.dataset.DatasetService/ProcessUploadPresignUrl'].post
  update:
    x-apievangelist-phrasing:
      intent: Process an uploaded dataset file
      effect: write
      questions:
      - After I upload a file to the presigned URL, how do I get it ingested?
      - Can I trigger processing for a new version of an uploaded dataset?
      instructions:
      - text: Process the uploaded file for dataset {dataset}.
        slots:
          dataset: requestBody.datasetId
      - text: Ingest version {version} of uploaded dataset {dataset}.
        slots:
          version: requestBody.datasetVersion
          dataset: requestBody.datasetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.dataset.DatasetService/UpdateDataset'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename a dataset
      effect: write
      questions:
      - How do I rename a dataset?
      - Can I change a dataset's metadata after uploading it?
      instructions:
      - text: Rename dataset {dataset} to {name}.
        slots:
          dataset: requestBody.datasetId
          name: requestBody.name
      - text: Update the name of dataset {dataset} to {name}.
        slots:
          dataset: requestBody.datasetId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'