Snowflake · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snowflake Warehouse API

16 actions 16 updates phrasing extends openapi/snowflake-warehouse-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/warehouses'].get
$.paths['/api/v2/warehouses'].post
$.paths['/api/v2/warehouses/{name}'].get
$.paths['/api/v2/warehouses/{name}'].put
$.paths['/api/v2/warehouses/{name}'].delete
$.paths['/api/v2/warehouses/{name}:resume'].post
$.paths['/api/v2/warehouses/{name}:suspend'].post
$.paths['/api/v2/warehouses/{name}:rename'].post
$.paths['/api/v2/warehouses/{name}:abort'].post
$.paths['/api/v2/warehouses/{name}:use'].post
$.paths['/api/v2/warehouses/{name}:enable'].post
$.paths['/api/v2/warehouses/{name}:disable'].post
$.paths['/api/v2/warehouses/{name}:set-tags'].post
$.paths['/api/v2/warehouses/{name}:unset-tags'].post
$.paths['/api/v2/warehouses/{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 Warehouse API
  version: 1.0.0
extends: openapi/snowflake-warehouse-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/warehouses'].get
  update:
    x-apievangelist-phrasing:
      intent: List virtual warehouses
      effect: read
      questions:
      - Which virtual warehouses exist in my Snowflake account?
      - Can I filter the list of warehouses by a name pattern?
      instructions:
      - text: List all the virtual warehouses in the account.
      - text: Show warehouses whose names match analytics.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/warehouses'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a virtual warehouse
      effect: write
      questions:
      - How do I spin up a new compute warehouse?
      - Can I set auto-suspend and a size when creating a warehouse?
      instructions:
      - text: Create a warehouse named {name} of size {warehouse_size}.
        slots:
          name: requestBody.name
          warehouse_size: requestBody.warehouse_size
      - text: Create warehouse {name} that auto-suspends after {auto_suspend} seconds and scales up to {max_cluster_count} clusters.
        slots:
          name: requestBody.name
          auto_suspend: requestBody.auto_suspend
          max_cluster_count: requestBody.max_cluster_count
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/warehouses/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe a warehouse
      effect: read
      questions:
      - What size and state is a particular warehouse in right now?
      - How can I see the settings of a single warehouse?
      instructions:
      - text: Describe warehouse {warehouse}.
        slots:
          warehouse: path.name
      - text: Show me the size, state and auto-suspend setting of this warehouse.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/warehouses/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or alter a warehouse with full settings
      effect: write
      questions:
      - Can I change an existing warehouse's settings by sending its full definition?
      - Does altering a warehouse through the PUT call require every property, not just the changed ones?
      instructions:
      - text: Create or alter warehouse {warehouse} so its size is {warehouse_size}.
        slots:
          warehouse: path.name
          warehouse_size: requestBody.warehouse_size
      - text: Apply the full definition for {name} with statement timeout {statement_timeout_in_seconds} seconds.
        slots:
          name: requestBody.name
          statement_timeout_in_seconds: requestBody.statement_timeout_in_seconds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/warehouses/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Drop a warehouse
      effect: destructive
      questions:
      - How do I permanently remove a virtual warehouse?
      - What happens when I drop a warehouse I no longer use?
      instructions:
      - text: Drop warehouse {warehouse}.
        slots:
          warehouse: path.name
      - text: Delete this virtual warehouse from the account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/warehouses/{name}:resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a suspended warehouse
      effect: write
      questions:
      - How do I bring a suspended warehouse back to running?
      - Can I start a warehouse so it provisions compute again?
      instructions:
      - text: Resume warehouse {warehouse}.
        slots:
          warehouse: path.name
      - text: Start this suspended warehouse so queries can run.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/warehouses/{name}:suspend'].post
  update:
    x-apievangelist-phrasing:
      intent: Suspend a running warehouse
      effect: write
      questions:
      - How do I stop a warehouse from burning credits when idle?
      - Can I suspend a warehouse to release its compute nodes?
      instructions:
      - text: Suspend warehouse {warehouse}.
        slots:
          warehouse: path.name
      - text: Put this running warehouse into a suspended state.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/warehouses/{name}:rename'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename a warehouse
      effect: write
      questions:
      - How do I give an existing warehouse a new name?
      - Does a new warehouse name need to be unique in the account?
      instructions:
      - text: Rename warehouse {warehouse} to {name}.
        slots:
          warehouse: path.name
          name: requestBody.name
      - text: Change the warehouse identifier to {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/warehouses/{name}:abort'].post
  update:
    x-apievangelist-phrasing:
      intent: Abort all queries on a warehouse
      effect: destructive
      questions:
      - How can I kill every running and queued query on a warehouse?
      - Is there a way to clear a warehouse's query queue at once?
      instructions:
      - text: Abort all queries on warehouse {warehouse}.
        slots:
          warehouse: path.name
      - text: Cancel every running and queued query on this warehouse.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/warehouses/{name}:use'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the session's current warehouse
      effect: write
      questions:
      - How do I make a warehouse the active one for my session?
      - Is the endpoint that sets the current session warehouse deprecated?
      instructions:
      - text: Use warehouse {warehouse} for my current session.
        slots:
          warehouse: path.name
      - text: Make the warehouse I named the active session warehouse.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/warehouses/{name}:enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable an adaptive warehouse
      effect: write
      questions:
      - How do I switch an adaptive warehouse to enabled?
      - Can I turn an adaptive warehouse back on after disabling it?
      instructions:
      - text: Enable adaptive warehouse {warehouse}.
        slots:
          warehouse: path.name
      - text: Put this adaptive warehouse into the enabled state.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/warehouses/{name}:disable'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable an adaptive warehouse
      effect: write
      questions:
      - How do I switch off an adaptive warehouse?
      - Can an adaptive warehouse be put into a disabled state?
      instructions:
      - text: Disable adaptive warehouse {warehouse}.
        slots:
          warehouse: path.name
      - text: Put this adaptive warehouse into the disabled state.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/warehouses/{name}:set-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Set tags on a warehouse
      effect: write
      questions:
      - How do I tag a warehouse for cost allocation?
      - Can I attach a department tag to a warehouse?
      instructions:
      - text: Set tags on warehouse {warehouse}.
        slots:
          warehouse: path.name
      - text: Tag the warehouse I named with our cost center.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/warehouses/{name}:unset-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from a warehouse
      effect: write
      questions:
      - How can I remove a tag from a warehouse?
      - Can I clear the cost center tag on a warehouse?
      instructions:
      - text: Unset tags from warehouse {warehouse}.
        slots:
          warehouse: path.name
      - text: Remove the department tag from the warehouse I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/warehouses/{name}:get-tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Get tag assignments for a warehouse
      effect: read
      questions:
      - Which tags are assigned to a warehouse?
      - Does checking a warehouse's tags need an active warehouse?
      instructions:
      - text: Show all tags assigned to warehouse {warehouse}.
        slots:
          warehouse: path.name
      - text: List the tag assignments on the warehouse I named.
      method: generated
      generated: '2026-10-01'