Sigma Computing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sigma Computing Datasets API

10 actions 10 updates phrasing extends openapi/sigma-computing-datasets-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Sigma Computing's API. It is a proposal applied on top of the contract, not a document Sigma Computing publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/v2/datasets'].get
$.paths['/v2/datasets/{datasetId}'].get
$.paths['/v2/datasets/{datasetId}/grants'].get
$.paths['/v2/datasets/{datasetId}/grants'].post
$.paths['/v2/datasets/{datasetId}/grants/{grantId}'].delete
$.paths['/v2/datasets/{datasetId}/materialization'].get
$.paths['/v2/datasets/{datasetId}/materialization'].post
$.paths['/v2/datasets/{datasetId}/migrate'].post
$.paths['/v2/datasets/{datasetId}/sources'].get

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 Sigma Computing Datasets API
  version: 1.0.0
extends: openapi/sigma-computing-datasets-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: 9
- target: $.paths['/v2/datasets'].get
  update:
    x-apievangelist-phrasing:
      intent: List datasets (deprecated)
      effect: read
      questions:
      - Which legacy datasets do I still have access to?
      - Can an admin list datasets without a permission check?
      instructions:
      - text: List all the deprecated datasets I can access.
      - text: List datasets, {limit} per page.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/datasets/{datasetId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dataset (deprecated)
      effect: read
      questions:
      - How do I look up one legacy dataset by ID?
      - What details are returned for a deprecated dataset?
      instructions:
      - text: Get dataset {datasetId}.
        slots:
          datasetId: path.datasetId
      - text: Show the details of legacy dataset {datasetId}.
        slots:
          datasetId: path.datasetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/datasets/{datasetId}/grants'].get
  update:
    x-apievangelist-phrasing:
      intent: List permissions on a dataset
      effect: read
      questions:
      - Who has been granted access to a dataset?
      - Which teams have permissions on a legacy dataset?
      instructions:
      - text: List grants on dataset {datasetId}.
        slots:
          datasetId: path.datasetId
      - text: Show which users and teams can access dataset {datasetId}.
        slots:
          datasetId: path.datasetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/datasets/{datasetId}/grants'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant access to a dataset
      effect: write
      questions:
      - How do I give a team access to a legacy dataset?
      - Can I grant dataset permissions to several users at once?
      instructions:
      - text: Grant {grants} on dataset {datasetId}.
        slots:
          grants: requestBody.grants
          datasetId: path.datasetId
      - text: Give the users and teams in {grants} access to dataset {datasetId}.
        slots:
          grants: requestBody.grants
          datasetId: path.datasetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/datasets/{datasetId}/grants/{grantId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a dataset permission
      effect: destructive
      questions:
      - How do I remove someone's access to a dataset?
      - Can I delete a single grant on a legacy dataset?
      instructions:
      - text: Delete grant {grantId} on dataset {datasetId}.
        slots:
          grantId: path.grantId
          datasetId: path.datasetId
      - text: Revoke dataset {datasetId} access given by grant {grantId}.
        slots:
          datasetId: path.datasetId
          grantId: path.grantId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/datasets/{datasetId}/materialization'].get
  update:
    x-apievangelist-phrasing:
      intent: List a dataset's materialization jobs
      effect: read
      questions:
      - When did a dataset last materialize?
      - What materialization runs exist for a legacy dataset?
      instructions:
      - text: List materialization jobs for dataset {datasetId}.
        slots:
          datasetId: path.datasetId
      - text: Show the materialization history of dataset {datasetId}.
        slots:
          datasetId: path.datasetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/datasets/{datasetId}/materialization'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a dataset materialization run
      effect: write
      questions:
      - How do I trigger a materialization for a dataset right now?
      - Does a dataset need a materialization schedule before I can run one?
      instructions:
      - text: Materialize dataset {datasetId} now.
        slots:
          datasetId: path.datasetId
      - text: Start a materialization run for legacy dataset {datasetId}.
        slots:
          datasetId: path.datasetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/datasets/{datasetId}/migrate'].post
  update:
    x-apievangelist-phrasing:
      intent: Migrate a dataset to a data model
      effect: write
      questions:
      - How do I convert a deprecated dataset into a data model?
      - Can I dry-run a dataset migration to see what would change?
      - Will migrating a dataset update the documents that reference it?
      instructions:
      - text: 'Migrate dataset {datasetId} to a data model, updating references: {shouldUpdateReferences}.'
        slots:
          datasetId: path.datasetId
          shouldUpdateReferences: requestBody.shouldUpdateReferences
      - text: Dry-run migrating dataset {datasetId} into folder {destFolderId} with reference updates {shouldUpdateReferences}.
        slots:
          datasetId: path.datasetId
          destFolderId: requestBody.destFolderId
          shouldUpdateReferences: requestBody.shouldUpdateReferences
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/datasets/{datasetId}/sources'].get
  update:
    x-apievangelist-phrasing:
      intent: List a dataset's sources
      effect: read
      questions:
      - Which tables or datasets does a dataset draw from?
      - How do I find the upstream inode IDs of a dataset?
      instructions:
      - text: List the sources of dataset {datasetId}.
        slots:
          datasetId: path.datasetId
      - text: Show which tables feed dataset {datasetId}.
        slots:
          datasetId: path.datasetId
      method: generated
      generated: '2026-09-26'