Snowflake · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snowflake Result API

2 actions 2 updates phrasing extends openapi/snowflake-result-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 2

$.info

$.paths['/api/v2/results/{result_handler}'].get

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 Result API
  version: 1.0.0
extends: openapi/snowflake-result-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: 1
- target: $.paths['/api/v2/results/{result_handler}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an async request's status or fetch its result
      effect: read
      questions:
      - How do I check whether a long-running REST request has finished?
      - Can I page through the result of an asynchronous request once it's ready?
      instructions:
      - text: Check the status of result {result_handler}.
        slots:
          result_handler: path.result_handler
      - text: Fetch page {page} of result {result_handler}.
        slots:
          page: query.page
          result_handler: path.result_handler
      method: generated
      generated: '2026-10-01'