Snowflake · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snowflake Compute Pools Compute Pool API

14 actions 14 updates phrasing extends openapi/snowflake-compute-pool-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 14

$.info
$.paths['/api/v2/compute-pools'].get
$.paths['/api/v2/compute-pools'].post
$.paths['/api/v2/compute-pools/{name}'].get
$.paths['/api/v2/compute-pools/{name}'].put
$.paths['/api/v2/compute-pools/{name}'].delete
$.paths['/api/v2/compute-pools/{name}:resume'].post
$.paths['/api/v2/compute-pools/{name}:suspend'].post
$.paths['/api/v2/compute-pools/{name}:stopallservices'].post
$.paths['/api/v2/compute-pools/{name}:stop-all-services'].post
$.paths['/api/v2/compute-pools/instance-families'].get
$.paths['/api/v2/compute-pools/{name}:set-tags'].post
$.paths['/api/v2/compute-pools/{name}:unset-tags'].post
$.paths['/api/v2/compute-pools/{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 Compute Pools Compute Pool API
  version: 1.0.0
extends: openapi/snowflake-compute-pool-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: 13
- target: $.paths['/api/v2/compute-pools'].get
  update:
    x-apievangelist-phrasing:
      intent: List compute pools in the account
      effect: read
      questions:
      - Which compute pools exist in my Snowflake account?
      - Can I see all compute pools and their states in one call?
      instructions:
      - text: List the compute pools in my account.
      - text: Show me every compute pool we have.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/compute-pools'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a compute pool
      effect: write
      questions:
      - How do I create a compute pool for running container services?
      - Can I create a compute pool that starts out suspended?
      - What node counts and instance family does a new compute pool need?
      instructions:
      - text: Create compute pool {name} with {min} to {max} nodes of instance family {family}.
        slots:
          name: requestBody.name
          min: requestBody.min_nodes
          max: requestBody.max_nodes
          family: requestBody.instance_family
      - text: Create compute pool {name} ({family}, {min}-{max} nodes) initially suspended {suspended}.
        slots:
          name: requestBody.name
          family: requestBody.instance_family
          min: requestBody.min_nodes
          max: requestBody.max_nodes
          suspended: query.initiallySuspended
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/compute-pools/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the details of a compute pool
      effect: read
      questions:
      - How many active and idle nodes does a specific compute pool have?
      - Where can I read one compute pool's configuration and state?
      instructions:
      - text: Show me the details of compute pool {name}.
        slots:
          name: path.name
      - text: Fetch the named compute pool's node counts and status.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/compute-pools/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a compute pool definition
      effect: write
      questions:
      - Can I resize an existing compute pool by sending its full definition?
      - Which call creates a compute pool if missing or alters it when it exists?
      instructions:
      - text: Create or alter compute pool {name} to run {min} to {max} {family} nodes.
        slots:
          name: path.name
          min: requestBody.min_nodes
          max: requestBody.max_nodes
          family: requestBody.instance_family
      - text: Update compute pool {name} ({family}, {min}-{max} nodes) to auto suspend after {secs} seconds.
        slots:
          name: requestBody.name
          family: requestBody.instance_family
          min: requestBody.min_nodes
          max: requestBody.max_nodes
          secs: requestBody.auto_suspend_secs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/compute-pools/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a compute pool
      effect: destructive
      questions:
      - How do I drop a compute pool I'm finished with?
      - Does deleting a compute pool fail with a 404 if it doesn't exist?
      instructions:
      - text: Delete compute pool {name}.
        slots:
          name: path.name
      - text: Drop the compute pool permanently.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/compute-pools/{name}:resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a suspended compute pool
      effect: write
      questions:
      - How do I start a suspended compute pool again?
      - What error do I get if I resume a compute pool that's already running?
      instructions:
      - text: Resume compute pool {name}.
        slots:
          name: path.name
      - text: Bring the suspended compute pool back online.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/compute-pools/{name}:suspend'].post
  update:
    x-apievangelist-phrasing:
      intent: Suspend an active compute pool
      effect: write
      questions:
      - How do I suspend a compute pool so it stops consuming credits?
      - What happens if I suspend a compute pool that's already suspended?
      instructions:
      - text: Suspend compute pool {name}.
        slots:
          name: path.name
      - text: Pause the active compute pool.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/compute-pools/{name}:stopallservices'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop all services in a pool (legacy endpoint)
      effect: destructive
      questions:
      - Is the old :stopallservices endpoint still available for stopping a pool's services?
      - Does the deprecated stopallservices route behave like the newer one?
      instructions:
      - text: Use the deprecated stopallservices endpoint to stop every service in pool {name}.
        slots:
          name: path.name
      - text: Call the legacy stopallservices route on the compute pool.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/compute-pools/{name}:stop-all-services'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop all services running in a compute pool
      effect: destructive
      questions:
      - How do I shut down every service running on one compute pool at once?
      - Can I clear a compute pool of all its services before suspending it?
      instructions:
      - text: Stop all services running in compute pool {name}.
        slots:
          name: path.name
      - text: Shut down every service on the compute pool using stop-all-services.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/compute-pools/instance-families'].get
  update:
    x-apievangelist-phrasing:
      intent: List available compute pool instance families
      effect: read
      questions:
      - Which instance families can I choose from when creating a compute pool?
      - Are GPU instance families available for compute pools in my account?
      instructions:
      - text: List the instance families available for compute pools.
      - text: Show me which machine types a compute pool can use.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/compute-pools/{name}:set-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach tags to a compute pool
      effect: write
      questions:
      - How do I tag a compute pool for cost tracking?
      - Can I set tag values on a compute pool through the API?
      instructions:
      - text: Set tags on compute pool {name}.
        slots:
          name: path.name
      - text: Tag the compute pool with our team's cost-center value.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/compute-pools/{name}:unset-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from a compute pool
      effect: write
      questions:
      - How do I remove a tag from a compute pool?
      - Can I clear tag assignments on a compute pool without dropping the tag?
      instructions:
      - text: Unset the tags on compute pool {name}.
        slots:
          name: path.name
      - text: Strip the tag assignments off the compute pool.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/compute-pools/{name}:get-tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the tags assigned to a compute pool
      effect: read
      questions:
      - Which tags are assigned to this compute pool?
      - Does reading a compute pool's tags need an active warehouse?
      instructions:
      - text: Show every tag assigned to compute pool {name}.
        slots:
          name: path.name
      - text: Get the compute pool's current tag assignments.
      method: generated
      generated: '2026-10-01'