API Evangelist conversational phrasing for Sigma Computing Connections 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 Connections API
  version: 1.0.0
extends: openapi/sigma-computing-connections-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: 22
- target: $.paths['/v2/connection/{connectionId}/lookup'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up a warehouse object by its path
      effect: read
      questions:
      - How do I find the connection path ID for a schema or table by its name path?
      - Can I resolve a fully qualified database path inside a connection?
      instructions:
      - text: Look up path {path} in connection {connectionId}.
        slots:
          path: requestBody.path
          connectionId: path.connectionId
      - text: Resolve the object at {path} within connection {connectionId}.
        slots:
          path: requestBody.path
          connectionId: path.connectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List my warehouse connections
      effect: read
      questions:
      - Which data warehouse connections does my Sigma organization have?
      - Can I include archived connections or search connections by name?
      instructions:
      - text: List all my connections.
      - text: Search connections for {search}, including archived ones set to {includeArchived}.
        slots:
          search: query.search
          includeArchived: query.includeArchived
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect a cloud data warehouse
      effect: write
      questions:
      - How do I connect Sigma to my cloud data warehouse through the API?
      - Can I set pool sizes and a query timeout when creating a connection?
      instructions:
      - text: Create a connection named {name} with details {details}.
        slots:
          name: requestBody.name
          details: requestBody.details
      - text: Add warehouse connection {name} using {details} and a timeout of {timeoutSecs} seconds.
        slots:
          name: requestBody.name
          details: requestBody.details
          timeoutSecs: requestBody.timeoutSecs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connections/{connectionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a connection's metadata
      effect: read
      questions:
      - What are the settings of one of my warehouse connections?
      - Where can I see a connection's details by its ID?
      instructions:
      - text: Get details for connection {connectionId}.
        slots:
          connectionId: path.connectionId
      - text: Show the metadata of connection {connectionId}.
        slots:
          connectionId: path.connectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connections/{connectionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update or restore a connection
      effect: write
      questions:
      - How do I change a connection's settings while keeping the details I want?
      - Can I restore an archived connection?
      instructions:
      - text: Update connection {connectionId} with its full new details.
        slots:
          connectionId: path.connectionId
      - text: Restore archived connection {connectionId} by setting restore to {restore}.
        slots:
          connectionId: path.connectionId
          restore: requestBody.restore
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connections/{connectionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a warehouse connection
      effect: destructive
      questions:
      - How do I remove a data warehouse connection from Sigma?
      - Can I delete a connection by its ID?
      instructions:
      - text: Delete connection {connectionId}.
        slots:
          connectionId: path.connectionId
      - text: Remove warehouse connection {connectionId} from my organization.
        slots:
          connectionId: path.connectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connections/{connectionId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a connection (deprecated PATCH)
      effect: write
      questions:
      - Is there an older deprecated endpoint to rename a connection or toggle OAuth?
      - Can the legacy PATCH connection call switch a connection to OAuth?
      instructions:
      - text: Using the deprecated PATCH, rename connection {connectionId} to {name}.
        slots:
          connectionId: path.connectionId
          name: requestBody.name
      - text: Set OAuth to {useOauth} on connection {connectionId} with the legacy update.
        slots:
          useOauth: requestBody.useOauth
          connectionId: path.connectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connections/{connectionId}/dbtArtifacts'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload dbt run artifacts for a connection
      effect: write
      questions:
      - How do I push dbt Core metadata into Sigma for a connection?
      - Can Sigma show dbt descriptions from my run artifacts?
      instructions:
      - text: Add dbt artifacts {artifacts} to connection {connectionId}.
        slots:
          artifacts: requestBody.artifacts
          connectionId: path.connectionId
      - text: 'Upload these dbt run artifacts for connection {connectionId}: {artifacts}.'
        slots:
          connectionId: path.connectionId
          artifacts: requestBody.artifacts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connections/{connectionId}/grants'].get
  update:
    x-apievangelist-phrasing:
      intent: List who has access to a connection
      effect: read
      questions:
      - Which users and teams have permissions on a connection?
      - How can I audit access to a warehouse connection?
      instructions:
      - text: List the grants on connection {connectionId}.
        slots:
          connectionId: path.connectionId
      - text: Show who can use connection {connectionId}.
        slots:
          connectionId: path.connectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connections/{connectionId}/grants'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant users or teams access to a connection
      effect: write
      questions:
      - How do I let a team query a warehouse connection?
      - Can I give several users permissions on a connection at once?
      instructions:
      - text: Add grants {grants} to connection {connectionId}.
        slots:
          grants: requestBody.grants
          connectionId: path.connectionId
      - text: 'Give these users and teams access to connection {connectionId}: {grants}.'
        slots:
          connectionId: path.connectionId
          grants: requestBody.grants
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connections/{connectionId}/grants/{grantId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a permission on a connection
      effect: destructive
      questions:
      - How do I take away a team's access to a whole connection?
      - Can I delete one grant on a connection?
      instructions:
      - text: Delete grant {grantId} on connection {connectionId}.
        slots:
          grantId: path.grantId
          connectionId: path.connectionId
      - text: Revoke connection {connectionId} access for grant {grantId}.
        slots:
          connectionId: path.connectionId
          grantId: path.grantId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connections/{connectionId}/sync'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync warehouse changes for a connection path
      effect: write
      questions:
      - How do I make Sigma pick up new columns or tables from my warehouse?
      - Can I sync a single schema or table instead of the whole connection?
      instructions:
      - text: Sync path {path} on connection {connectionId}.
        slots:
          path: requestBody.path
          connectionId: path.connectionId
      - text: Refresh schema changes at {path} in connection {connectionId} using the service account set to {useServiceAccount}.
        slots:
          path: requestBody.path
          connectionId: path.connectionId
          useServiceAccount: query.useServiceAccount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connections/{connectionId}/test'].get
  update:
    x-apievangelist-phrasing:
      intent: Test read and write access on a connection
      effect: read
      questions:
      - Does my connection allow reads and writes for the API user?
      - How do I verify a warehouse connection is working?
      instructions:
      - text: Test connection {connectionId}.
        slots:
          connectionId: path.connectionId
      - text: Check whether connection {connectionId} permits read and write operations.
        slots:
          connectionId: path.connectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connections/paths'].get
  update:
    x-apievangelist-phrasing:
      intent: List databases, schemas and tables I can reach
      effect: read
      questions:
      - Which databases, schemas and tables are available to me across connections?
      - Can I list paths for just one connection?
      instructions:
      - text: List all connection paths available to me.
      - text: List the databases, schemas and tables in connection {connectionId}.
        slots:
          connectionId: query.connectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connections/paths/{connectionPathId}/grants'].get
  update:
    x-apievangelist-phrasing:
      intent: List grants on a schema or table path
      effect: read
      questions:
      - Who has permissions on a specific schema or table within a connection?
      - How can I audit access to a single connection path?
      instructions:
      - text: List the grants on connection path {connectionPathId}.
        slots:
          connectionPathId: path.connectionPathId
      - text: Show who can access schema or table path {connectionPathId}.
        slots:
          connectionPathId: path.connectionPathId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connections/paths/{connectionPathId}/grants'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant access to a schema or table path
      effect: write
      questions:
      - How do I give a team access to only one schema in a connection?
      - Can I grant permissions on a single table path?
      instructions:
      - text: Add grants {grants} to connection path {connectionPathId}.
        slots:
          grants: requestBody.grants
          connectionPathId: path.connectionPathId
      - text: 'Give these users and teams access to path {connectionPathId}: {grants}.'
        slots:
          connectionPathId: path.connectionPathId
          grants: requestBody.grants
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connections/paths/{connectionPathId}/grants/{grantId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a grant on a schema or table path
      effect: destructive
      questions:
      - How do I remove someone's access to a specific schema or table?
      - Can I revoke one grant from a connection path?
      instructions:
      - text: Delete grant {grantId} on connection path {connectionPathId}.
        slots:
          grantId: path.grantId
          connectionPathId: path.connectionPathId
      - text: Revoke path {connectionPathId} access for grant {grantId}.
        slots:
          connectionPathId: path.connectionPathId
          grantId: path.grantId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connections/paths/{inodeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the warehouse path for a table
      effect: read
      questions:
      - Where in my warehouse does a table used in Sigma live?
      - Can I find the connection path for a table by its inode ID?
      instructions:
      - text: Get the connection path for table {inodeId}.
        slots:
          inodeId: path.inodeId
      - text: Show the database and schema location of table inode {inodeId}.
        slots:
          inodeId: path.inodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/connections/tables/{tableId}/columns'].get
  update:
    x-apievangelist-phrasing:
      intent: List columns of a warehouse table
      effect: read
      questions:
      - What columns and data types does a warehouse table have?
      - Can I inspect a table's schema through a Sigma connection?
      instructions:
      - text: List the columns of warehouse table {tableId}.
        slots:
          tableId: path.tableId
      - text: Show column names and types for table {tableId}, {pageSize} per page.
        slots:
          tableId: path.tableId
          pageSize: query.pageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3alpha/connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a connection (v3alpha beta)
      effect: write
      questions:
      - Is there a beta v3alpha endpoint for creating warehouse connections?
      - Can I try the private-beta connection creation API?
      instructions:
      - text: Using the v3alpha beta API, create connection {name} with {details}.
        slots:
          name: requestBody.name
          details: requestBody.details
      - text: Create beta connection {name} through v3alpha from details {details}.
        slots:
          name: requestBody.name
          details: requestBody.details
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3alpha/connections/{connectionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get connection details (v3alpha beta)
      effect: read
      questions:
      - How do I read a connection's metadata from the v3alpha beta API?
      - Does the beta v3alpha API return connection details by ID?
      instructions:
      - text: Get connection {connectionId} from the v3alpha beta API.
        slots:
          connectionId: path.connectionId
      - text: Fetch v3alpha details for connection {connectionId}.
        slots:
          connectionId: path.connectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3alpha/connections/{connectionId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a connection (v3alpha beta)
      effect: write
      questions:
      - Can I change only some options of a connection with the v3alpha beta endpoint?
      - Which beta endpoint updates a connection without resending every detail?
      instructions:
      - text: Rename connection {connectionId} to {name} via the v3alpha beta patch.
        slots:
          connectionId: path.connectionId
          name: requestBody.name
      - text: Patch only {details} on connection {connectionId} using v3alpha.
        slots:
          details: requestBody.details
          connectionId: path.connectionId
      method: generated
      generated: '2026-09-26'