Snowflake · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snowflake SQL REST Statements API

4 actions 4 updates phrasing extends openapi/snowflake-statements-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 4

$.info

$.paths['/api/v2/statements'].post

$.paths['/api/v2/statements/{statementHandle}'].get

$.paths['/api/v2/statements/{statementHandle}/cancel'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snowflake SQL REST Statements API
  version: 1.0.0
extends: openapi/snowflake-statements-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: 3
- target: $.paths['/api/v2/statements'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a SQL statement
      effect: write
      questions:
      - How do I run a SQL query against Snowflake over REST?
      - Can I submit a statement asynchronously and check on it later?
      - Which SQL statement types can't be run through the SQL API?
      instructions:
      - text: Run the SQL statement {statement} on warehouse {warehouse}.
        slots:
          statement: requestBody.statement
          warehouse: requestBody.warehouse
      - text: Execute {statement} in database {database} and schema {schema} as role {role}.
        slots:
          statement: requestBody.statement
          database: requestBody.database
          schema: requestBody.schema
          role: requestBody.role
      - text: Submit {statement} asynchronously with a timeout of {timeout} seconds.
        slots:
          statement: requestBody.statement
          timeout: requestBody.timeout
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/statements/{statementHandle}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a statement's status and fetch results
      effect: read
      questions:
      - Has my asynchronous SQL statement finished running?
      - How do I fetch a later partition of a large result set?
      instructions:
      - text: Check the status of statement {statementHandle}.
        slots:
          statementHandle: path.statementHandle
      - text: Get result partition {partition} for statement {statementHandle}.
        slots:
          partition: query.partition
          statementHandle: path.statementHandle
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/statements/{statementHandle}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running SQL statement
      effect: destructive
      questions:
      - How do I stop a long-running SQL statement I submitted?
      - Can I cancel a query using only its statement handle?
      instructions:
      - text: Cancel statement {statementHandle}.
        slots:
          statementHandle: path.statementHandle
      - text: Stop the execution of the query with handle {statementHandle}.
        slots:
          statementHandle: path.statementHandle
      method: generated
      generated: '2026-10-01'