API Evangelist conversational phrasing for Sigma Computing Data Models API

# 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 Data Models API
  version: 1.0.0
extends: openapi/sigma-computing-data-models-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: 24
- target: $.paths['/v2/dataModels'].get
  update:
    x-apievangelist-phrasing:
      intent: List the data models in my organization
      effect: read
      questions:
      - Which data models exist in Sigma so I can spot duplicates or gaps?
      - Can I list data models without their version tag details?
      instructions:
      - text: List all data models I can access.
      - text: List data models, {limit} per page.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/{dataModelId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one data model
      effect: read
      questions:
      - What are the name, owner and location of a specific data model?
      - Can I look up one data model by its ID?
      instructions:
      - text: Get the details of data model {dataModelId}.
        slots:
          dataModelId: path.dataModelId
      - text: Show metadata for data model {dataModelId} without tag info set to {excludeTags}.
        slots:
          dataModelId: path.dataModelId
          excludeTags: query.excludeTags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/{dataModelId}:materialize'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a materialization for a data model element now
      effect: write
      questions:
      - How do I trigger a materialization of a data model element on demand?
      - Can I refresh the cached data for one data model sheet right away?
      instructions:
      - text: Materialize element {sheetId} in data model {dataModelId} now.
        slots:
          sheetId: requestBody.sheetId
          dataModelId: path.dataModelId
      - text: Run the scheduled materialization for sheet {sheetId} of data model {dataModelId}.
        slots:
          sheetId: requestBody.sheetId
          dataModelId: path.dataModelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/{dataModelId}/columns'].get
  update:
    x-apievangelist-phrasing:
      intent: List columns across a data model
      effect: read
      questions:
      - What columns exist across all elements of a data model?
      - Can I get a full column inventory for one data model?
      instructions:
      - text: List every column in data model {dataModelId}.
        slots:
          dataModelId: path.dataModelId
      - text: Show all data model columns for {dataModelId}, {limit} per page.
        slots:
          dataModelId: path.dataModelId
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/{dataModelId}/elements'].get
  update:
    x-apievangelist-phrasing:
      intent: List elements in a data model
      effect: read
      questions:
      - Which tables and controls make up a data model?
      - Can I list data model elements as of a version tag?
      instructions:
      - text: List the elements of data model {dataModelId}.
        slots:
          dataModelId: path.dataModelId
      - text: Show data model {dataModelId}'s tables and controls for tag {tagName}.
        slots:
          dataModelId: path.dataModelId
          tagName: query.tagName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/{dataModelId}/elements/{elementId}/columnSecurityRules'].get
  update:
    x-apievangelist-phrasing:
      intent: List column-level security rules on an element
      effect: read
      questions:
      - Which column-level security rules protect a data model table?
      - How can I audit who can see restricted columns in a data model element?
      instructions:
      - text: List column security rules on element {elementId} of data model {dataModelId}.
        slots:
          elementId: path.elementId
          dataModelId: path.dataModelId
      - text: Show the CLS rules for data model {dataModelId} element {elementId}.
        slots:
          dataModelId: path.dataModelId
          elementId: path.elementId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/{dataModelId}/elements/{elementId}/columnSecurityRules'].post
  update:
    x-apievangelist-phrasing:
      intent: Add column-level security rules to an element
      effect: write
      questions:
      - How do I hide sensitive columns in a data model from certain users?
      - Can I create several column security rules on one element at once?
      instructions:
      - text: Create column security rules on element {elementId} in data model {dataModelId}.
        slots:
          elementId: path.elementId
          dataModelId: path.dataModelId
      - text: Restrict columns on data model {dataModelId} element {elementId} with new CLS rules.
        slots:
          dataModelId: path.dataModelId
          elementId: path.elementId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/{dataModelId}/elements/{elementId}/columnSecurityRules/{columnSecurityRuleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a column-level security rule
      effect: write
      questions:
      - How do I change which columns an existing CLS rule covers?
      - Can I update the access criteria of a column security rule?
      instructions:
      - text: Update CLS rule {columnSecurityRuleId} on element {elementId} of {dataModelId} to cover {columns} with criteria {criteria}.
        slots:
          columnSecurityRuleId: path.columnSecurityRuleId
          elementId: path.elementId
          dataModelId: path.dataModelId
          columns: requestBody.columns
          criteria: requestBody.criteria
      - text: Replace rule {columnSecurityRuleId} in data model {dataModelId} element {elementId} using criteria {criteria} and columns {columns}.
        slots:
          columnSecurityRuleId: path.columnSecurityRuleId
          dataModelId: path.dataModelId
          elementId: path.elementId
          criteria: requestBody.criteria
          columns: requestBody.columns
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/{dataModelId}/elements/{elementId}/columnSecurityRules/{columnSecurityRuleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a column-level security rule
      effect: destructive
      questions:
      - How do I remove a column security rule from a data model element?
      - What happens to hidden columns when a CLS rule is deleted?
      instructions:
      - text: Delete CLS rule {columnSecurityRuleId} from element {elementId} in data model {dataModelId}.
        slots:
          columnSecurityRuleId: path.columnSecurityRuleId
          elementId: path.elementId
          dataModelId: path.dataModelId
      - text: Drop column security rule {columnSecurityRuleId} on {dataModelId} element {elementId}.
        slots:
          columnSecurityRuleId: path.columnSecurityRuleId
          dataModelId: path.dataModelId
          elementId: path.elementId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/{dataModelId}/elements/{elementId}/materializationSchedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a materialization schedule for an element
      effect: write
      questions:
      - How do I materialize a data model element automatically on a cron cadence?
      - Can I set up recurring caching for a data model table?
      instructions:
      - text: Create a materialization schedule {schedule} for element {elementId} in data model {dataModelId}.
        slots:
          schedule: requestBody.schedule
          elementId: path.elementId
          dataModelId: path.dataModelId
      - text: Schedule element {elementId} of {dataModelId} to materialize on {schedule}.
        slots:
          elementId: path.elementId
          dataModelId: path.dataModelId
          schedule: requestBody.schedule
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/{dataModelId}/elements/{elementId}/materializationSchedules'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an element's materialization schedule
      effect: destructive
      questions:
      - How do I stop scheduled materializations for a data model element?
      - Does deleting a materialization schedule cancel future runs?
      instructions:
      - text: Delete the materialization schedule on element {elementId} of data model {dataModelId}.
        slots:
          elementId: path.elementId
          dataModelId: path.dataModelId
      - text: Cancel scheduled materialization runs for {dataModelId} element {elementId}.
        slots:
          dataModelId: path.dataModelId
          elementId: path.elementId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/{dataModelId}/elements/{elementId}/materializationSchedules'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an element's materialization cadence
      effect: write
      questions:
      - How do I change the cron or timezone of an existing materialization schedule?
      - Can I adjust when a data model element materializes without recreating the schedule?
      instructions:
      - text: Change the materialization schedule of element {elementId} in {dataModelId} to {schedule}.
        slots:
          elementId: path.elementId
          dataModelId: path.dataModelId
          schedule: requestBody.schedule
      - text: Update data model {dataModelId} element {elementId} to materialize on cadence {schedule}.
        slots:
          dataModelId: path.dataModelId
          elementId: path.elementId
          schedule: requestBody.schedule
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/{dataModelId}/lineage'].get
  update:
    x-apievangelist-phrasing:
      intent: Show lineage for a data model
      effect: read
      questions:
      - What upstream sources feed the elements of a data model?
      - Can I see the full dependency graph of a data model?
      instructions:
      - text: List the lineage for data model {dataModelId}.
        slots:
          dataModelId: path.dataModelId
      - text: Map data sources and upstream lineage in data model {dataModelId}.
        slots:
          dataModelId: path.dataModelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/{dataModelId}/materializations/{materializationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a materialization job
      effect: read
      questions:
      - Did my data model materialization job finish, and when?
      - How do I troubleshoot a materialization run that seems stuck?
      instructions:
      - text: Get materialization job {materializationId} for data model {dataModelId}.
        slots:
          materializationId: path.materializationId
          dataModelId: path.dataModelId
      - text: Check the status of materialization {materializationId} in {dataModelId}.
        slots:
          materializationId: path.materializationId
          dataModelId: path.dataModelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/{dataModelId}/materializationSchedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List materialization schedules in a data model
      effect: read
      questions:
      - Which elements in a data model are materialized on a schedule?
      - How often does each data model element get materialized?
      instructions:
      - text: List all materialization schedules in data model {dataModelId}.
        slots:
          dataModelId: path.dataModelId
      - text: Show every scheduled materialization for {dataModelId}.
        slots:
          dataModelId: path.dataModelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/{dataModelId}/sources'].get
  update:
    x-apievangelist-phrasing:
      intent: List the sources a data model uses
      effect: read
      questions:
      - Which tables and custom SQL does a data model draw from?
      - What are the data sources behind my data model?
      instructions:
      - text: List the data sources of data model {dataModelId}.
        slots:
          dataModelId: path.dataModelId
      - text: Show which tables feed data model {dataModelId}.
        slots:
          dataModelId: path.dataModelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/{dataModelId}/spec'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a data model as code
      effect: read
      questions:
      - How can I get a data model as a JSON or YAML representation?
      - Can I export the code of an older version of a data model?
      instructions:
      - text: Get the code representation of data model {dataModelId}.
        slots:
          dataModelId: path.dataModelId
      - text: Export version {documentVersion} of data model {dataModelId} as a spec.
        slots:
          documentVersion: query.documentVersion
          dataModelId: path.dataModelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/{dataModelId}/spec'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a data model from code
      effect: write
      questions:
      - How do I update a data model's structure programmatically from a spec?
      - Does pushing a new spec to a data model create a new version?
      instructions:
      - text: Replace data model {dataModelId} with a spec using schema version {schemaVersion}.
        slots:
          dataModelId: path.dataModelId
          schemaVersion: requestBody.schemaVersion
      - text: Overwrite the contents of data model {dataModelId} from my code representation.
        slots:
          dataModelId: path.dataModelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/{dataModelId}/swapSources'].post
  update:
    x-apievangelist-phrasing:
      intent: Swap connections or tables behind a data model
      effect: write
      questions:
      - How do I move a data model from one connection to another?
      - Can I copy input table data when swapping data model sources?
      instructions:
      - text: Swap data model {dataModelId} to connections {connectionMapping}.
        slots:
          dataModelId: path.dataModelId
          connectionMapping: requestBody.connectionMapping
      - text: Swap the tables used by data model {dataModelId} per {sourceMapping}.
        slots:
          dataModelId: path.dataModelId
          sourceMapping: requestBody.sourceMapping
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/{dataModelId}/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List version tags on a data model
      effect: read
      questions:
      - Which version tags are applied to a data model?
      - Is my data model tagged for a production release?
      instructions:
      - text: List the version tags on data model {dataModelId}.
        slots:
          dataModelId: path.dataModelId
      - text: Show tag information for data model {dataModelId}.
        slots:
          dataModelId: path.dataModelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/spec'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data model from code
      effect: write
      questions:
      - How do I create a brand new data model from a code definition?
      - Can I build data models programmatically and still edit them in the Sigma UI?
      instructions:
      - text: Create a data model named {name} in folder {folderId} from my spec.
        slots:
          name: requestBody.name
          folderId: requestBody.folderId
      - text: Create data model {name} in {folderId} described as {description} from code.
        slots:
          name: requestBody.name
          folderId: requestBody.folderId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/tag'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a version tag to a data model
      effect: write
      questions:
      - How do I tag a data model version for release?
      - Can I set a tag as the default version of a data model?
      instructions:
      - text: Tag data model {dataModelId} with {tag}.
        slots:
          dataModelId: requestBody.dataModelId
          tag: requestBody.tag
      - text: Tag version {dataModelVersion} of data model {dataModelId} as {tag}.
        slots:
          dataModelVersion: requestBody.dataModelVersion
          dataModelId: requestBody.dataModelId
          tag: requestBody.tag
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3alpha/dataModels/{dataModelId}:swapSources'].post
  update:
    x-apievangelist-phrasing:
      intent: Swap data model sources (v3alpha beta)
      effect: write
      questions:
      - Is there a beta endpoint to swap custom SQL or data model element sources in a data model?
      - Can the v3alpha source swap replace each source of a data model individually?
      instructions:
      - text: Using the beta v3alpha swap, repoint data model {dataModelId} with {sourceMapping}.
        slots:
          dataModelId: path.dataModelId
          sourceMapping: requestBody.sourceMapping
      - text: Run the v3alpha source swap on {dataModelId} to replace each source via {sourceMapping}.
        slots:
          dataModelId: path.dataModelId
          sourceMapping: requestBody.sourceMapping
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/dataModels/{dataModelId}/elements/{elementId}/query'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the SQL behind a data model element
      effect: read
      questions:
      - How can I see the SQL a data model table generates?
      - What query does one data model element run, for a given tag?
      instructions:
      - text: Get the SQL for element {elementId} in data model {dataModelId}.
        slots:
          elementId: path.elementId
          dataModelId: path.dataModelId
      - text: Show the query for data model {dataModelId} element {elementId} at tag {tagName}.
        slots:
          dataModelId: path.dataModelId
          elementId: path.elementId
          tagName: query.tagName
      method: generated
      generated: '2026-10-01'