Snowflake · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snowflake Dynamic Table API

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

What the actions change

x-apievangelist-phrasing

Targets 16

$.info
$.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}'].delete
$.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:clone'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:undrop'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:suspend'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:resume'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:refresh'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:suspend-recluster'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:resume-recluster'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:swap-with'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:set-tags'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:unset-tags'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:get-tags'].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 Snowflake Dynamic Table API
  version: 1.0.0
extends: openapi/snowflake-dynamic-table-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: 15
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables'].get
  update:
    x-apievangelist-phrasing:
      intent: List dynamic tables in a schema
      effect: read
      questions:
      - Which dynamic tables exist in this schema?
      - Can I get extra detail on each dynamic table with the deep option?
      instructions:
      - text: List the dynamic tables in schema {schema} of database {database}.
        slots:
          database: path.database
          schema: path.schema
      - text: List dynamic tables with deep set to {deep}.
        slots:
          deep: query.deep
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a dynamic table
      effect: write
      questions:
      - How do I create a dynamic table that refreshes from a query automatically?
      - What target lag and warehouse does a new dynamic table need?
      - Can I choose incremental or full refresh mode when I define a dynamic table?
      instructions:
      - text: In {database}.{schema}, create dynamic table {name} from query {query} with target lag {lag} on warehouse {warehouse}.
        slots:
          database: path.database
          schema: path.schema
          name: requestBody.name
          query: requestBody.query
          lag: requestBody.target_lag
          warehouse: requestBody.warehouse
      - text: Create dynamic table {name} using {query}, lag {lag}, warehouse {warehouse} and refresh mode {mode}.
        slots:
          name: requestBody.name
          query: requestBody.query
          lag: requestBody.target_lag
          warehouse: requestBody.warehouse
          mode: requestBody.refresh_mode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the details of a dynamic table
      effect: read
      questions:
      - What query, target lag and scheduling state does a given dynamic table have?
      - Where can I read one dynamic table's definition and row count?
      instructions:
      - text: Show me the details of dynamic table {table} in {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          table: path.name
      - text: Fetch the dynamic table's definition and refresh settings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Drop a dynamic table
      effect: destructive
      questions:
      - How do I drop a dynamic table I no longer need?
      - Will deleting a dynamic table fail if it's already gone?
      instructions:
      - text: Drop dynamic table {table} from {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          table: path.name
      - text: Delete the dynamic table permanently.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a dynamic table
      effect: write
      questions:
      - Can I copy a dynamic table into another schema or database?
      - How do I clone a dynamic table as it was at an earlier point in time?
      instructions:
      - text: Clone dynamic table {table} in {database}.{schema} as {name}.
        slots:
          database: path.database
          schema: path.schema
          table: path.name
          name: requestBody.name
      - text: Clone the dynamic table into {database}.{schema} as {name}.
        slots:
          database: query.targetDatabase
          schema: query.targetSchema
          name: requestBody.name
      - text: Make a point-in-time copy of this dynamic table at {point_of_time} named {name}.
        slots:
          point_of_time: requestBody.point_of_time
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:undrop'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a dropped dynamic table
      effect: write
      questions:
      - Can I recover a dynamic table I dropped by mistake?
      - Is there a way to undrop a dynamic table?
      instructions:
      - text: Undrop dynamic table {table} in {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          table: path.name
      - text: Bring the dropped dynamic table back.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:suspend'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause refreshes on a dynamic table
      effect: write
      questions:
      - How do I stop a dynamic table from refreshing for a while?
      - Can I suspend a dynamic table's scheduled refreshes to save warehouse credits?
      instructions:
      - text: Suspend refreshes on dynamic table {table} in {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          table: path.name
      - text: Pause the dynamic table's automatic refresh schedule.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume refreshes on a dynamic table
      effect: write
      questions:
      - How do I turn scheduled refreshes back on for a suspended dynamic table?
      - Can a paused dynamic table start refreshing again?
      instructions:
      - text: Resume refreshes on dynamic table {table} in {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          table: path.name
      - text: Restart the dynamic table's refresh schedule.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:refresh'].post
  update:
    x-apievangelist-phrasing:
      intent: Manually refresh a dynamic table
      effect: write
      questions:
      - Can I force a dynamic table to refresh right now instead of waiting for its target lag?
      - How do I trigger a one-off manual refresh?
      instructions:
      - text: Refresh dynamic table {table} in {database}.{schema} now.
        slots:
          database: path.database
          schema: path.schema
          table: path.name
      - text: Trigger a manual refresh on the dynamic table.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:suspend-recluster'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause automatic reclustering of a dynamic table
      effect: write
      questions:
      - How do I stop automatic clustering from running on a dynamic table?
      - Can I suspend reclustering without stopping the table's refreshes?
      instructions:
      - text: Suspend reclustering on dynamic table {table} in {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          table: path.name
      - text: Turn off background recluster for the dynamic table.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:resume-recluster'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume automatic reclustering of a dynamic table
      effect: write
      questions:
      - How do I turn automatic clustering back on for a dynamic table?
      - Can reclustering be restarted after I suspended it?
      instructions:
      - text: Resume reclustering on dynamic table {table} in {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          table: path.name
      - text: Switch background recluster back on for the dynamic table.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:swap-with'].post
  update:
    x-apievangelist-phrasing:
      intent: Swap a dynamic table with another
      effect: write
      questions:
      - Can I atomically swap two dynamic tables to promote a rebuilt version?
      - How do I exchange a dynamic table with one in another schema?
      instructions:
      - text: Swap dynamic table {table} in {database}.{schema} with {target}.
        slots:
          database: path.database
          schema: path.schema
          table: path.name
          target: query.targetName
      - text: Swap the dynamic table with {target} in {database}.{schema}.
        slots:
          target: query.targetName
          database: query.targetDatabase
          schema: query.targetSchema
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:set-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach tags to a dynamic table
      effect: write
      questions:
      - How do I apply governance tags to a dynamic table?
      - Can I set tag values on a dynamic table through the API?
      instructions:
      - text: Set tags on dynamic table {table} in {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          table: path.name
      - text: Tag the dynamic table with our cost-center values.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:unset-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from a dynamic table
      effect: write
      questions:
      - How do I remove a tag from a dynamic table?
      - Can I clear tag assignments on a dynamic table without dropping the tag?
      instructions:
      - text: Unset the tags on dynamic table {table} in {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          table: path.name
      - text: Strip the tag assignments off the dynamic table.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:get-tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the tags assigned to a dynamic table
      effect: read
      questions:
      - Which tags are assigned to this dynamic table?
      - Does listing a dynamic table's tags need an active warehouse?
      instructions:
      - text: Show every tag assigned to dynamic table {table} in {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          table: path.name
      - text: Get the dynamic table's current tag assignments.
      method: generated
      generated: '2026-10-01'