Snowflake · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Snowflake Services Service API
17 actions
17 updates
phrasing
extends
openapi/snowflake-service-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.
What the actions change
x-apievangelist-phrasing
Targets 17 · first 16 shown; the file carries all of them
$.info
$.paths['/api/v2/databases/{database}/schemas/{schema}/services'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/services'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/services:execute-job'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/services/{name}'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/services/{name}'].put
$.paths['/api/v2/databases/{database}/schemas/{schema}/services/{name}'].delete
$.paths['/api/v2/databases/{database}/schemas/{schema}/services/{name}/logs'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/services/{name}/status'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/services/{name}/containers'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/services/{name}/instances'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/services/{name}/roles'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/services/{service}/roles/{name}/grants-of'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/services/{service}/roles/{name}/grants'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/services/{name}:resume'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/services/{name}:suspend'].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 Services Service API
version: 1.0.0
extends: openapi/snowflake-service-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: 16
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/services'].get
update:
x-apievangelist-phrasing:
intent: List container services in a schema
effect: read
questions:
- Which Snowpark Container Services services are running in this schema?
- Can I see every service defined under a database and schema?
instructions:
- text: List the container services in this schema.
- text: Show me all services under the current database and schema.
- text: List the container services in schema {schema} of database {database}.
slots:
database: path.database
schema: path.schema
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/services'].post
update:
x-apievangelist-phrasing:
intent: Create a container service
effect: write
questions:
- How do I deploy a long-running service on a compute pool from a spec?
- Can I set minimum and maximum instances when creating a service?
- What does createMode do if a service with the same name already exists?
instructions:
- text: Create service {name} on compute pool {compute_pool} using spec {spec}.
slots:
name: requestBody.name
compute_pool: requestBody.compute_pool
spec: requestBody.spec
- text: Create service {name} on {compute_pool} from {spec}, scaling between {min} and {max} instances.
slots:
name: requestBody.name
compute_pool: requestBody.compute_pool
spec: requestBody.spec
min: requestBody.min_instances
max: requestBody.max_instances
- text: Create service {name} with create mode {mode}.
slots:
name: requestBody.name
mode: query.createMode
- text: In {database}.{schema}, create service {name} on compute pool {compute_pool} from spec {spec}.
slots:
database: path.database
schema: path.schema
name: requestBody.name
compute_pool: requestBody.compute_pool
spec: requestBody.spec
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/services:execute-job'].post
update:
x-apievangelist-phrasing:
intent: Run a one-off job service
effect: write
questions:
- How do I run a batch job in a container that exits when it's done?
- Can I run a job service asynchronously instead of waiting for it to finish?
instructions:
- text: Execute job service {name} on compute pool {compute_pool} with spec {spec}.
slots:
name: requestBody.name
compute_pool: requestBody.compute_pool
spec: requestBody.spec
- text: Kick off job {name} on {compute_pool} from {spec} and don't wait for it (async {is_async}).
slots:
name: requestBody.name
compute_pool: requestBody.compute_pool
spec: requestBody.spec
is_async: requestBody.is_async_job
- text: In database {database}, schema {schema}, run one-off job {name} on pool {compute_pool} with spec {spec}.
slots:
database: path.database
schema: path.schema
name: requestBody.name
compute_pool: requestBody.compute_pool
spec: requestBody.spec
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/services/{name}'].get
update:
x-apievangelist-phrasing:
intent: Get the details of a service
effect: read
questions:
- What compute pool, instance counts and DNS name does a given service have?
- Where do I read one container service's full definition?
instructions:
- text: Show me the definition of this service.
- text: Fetch the named service's properties, including its owner and compute pool.
- text: Show the properties of service {service} in {database}.{schema}.
slots:
database: path.database
schema: path.schema
service: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/services/{name}'].put
update:
x-apievangelist-phrasing:
intent: Create or update a service definition
effect: write
questions:
- Can I change a running service's spec by resubmitting its full property set?
- Which call creates a service if missing or alters it when it already exists?
instructions:
- text: Create or alter service {name} on {compute_pool} to use spec {spec}.
slots:
name: requestBody.name
compute_pool: requestBody.compute_pool
spec: requestBody.spec
- text: Update service {name} so auto suspend happens after {secs} seconds, keeping pool {compute_pool} and spec {spec}.
slots:
name: requestBody.name
secs: requestBody.auto_suspend_secs
compute_pool: requestBody.compute_pool
spec: requestBody.spec
- text: Create or alter service {service} in {database}.{schema} on pool {compute_pool} with spec {spec}.
slots:
database: path.database
schema: path.schema
service: path.name
compute_pool: requestBody.compute_pool
spec: requestBody.spec
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/services/{name}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a service
effect: destructive
questions:
- How do I tear down a container service I no longer need?
- Will dropping a service fail if it doesn't exist?
instructions:
- text: Delete this container service.
- text: Drop the service permanently.
- text: Delete service {service} from schema {schema} in database {database}.
slots:
database: path.database
schema: path.schema
service: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/services/{name}/logs'].get
update:
x-apievangelist-phrasing:
intent: Read a service container's logs
effect: read
questions:
- How can I see the log output of a specific container in my service?
- Can I limit how many log lines come back from a service container?
instructions:
- text: Get the logs for container {container} on instance {instance}.
slots:
container: query.containerName
instance: query.instanceId
- text: Show the last {lines} log lines from container {container} on instance {instance}.
slots:
lines: query.numLines
container: query.containerName
instance: query.instanceId
- text: Fetch logs of container {container} on instance {instance} for service {service} in {database}.{schema}.
slots:
database: path.database
schema: path.schema
service: path.name
container: query.containerName
instance: query.instanceId
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/services/{name}/status'].get
update:
x-apievangelist-phrasing:
intent: Check a service's status
effect: read
questions:
- Is my container service running, pending or failed right now?
- Can I wait a few seconds for a service's status to settle before it returns?
instructions:
- text: Check the status of this service.
- text: Get the service status, waiting up to {timeout} seconds.
slots:
timeout: query.timeout
- text: Check the status of service {service} in {database}.{schema}.
slots:
database: path.database
schema: path.schema
service: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/services/{name}/containers'].get
update:
x-apievangelist-phrasing:
intent: List a service's containers
effect: read
questions:
- Which containers make up this service?
- Can I see each container of a service and its state?
instructions:
- text: List the containers in this service.
- text: Show every container running for the service.
- text: List the containers of service {service} in {database}.{schema}.
slots:
database: path.database
schema: path.schema
service: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/services/{name}/instances'].get
update:
x-apievangelist-phrasing:
intent: List a service's instances
effect: read
questions:
- How many instances of my service are running?
- Where can I see each instance of a container service?
instructions:
- text: List the instances of this service.
- text: Show all running instances for the service.
- text: List the instances of service {service} in {database}.{schema}.
slots:
database: path.database
schema: path.schema
service: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/services/{name}/roles'].get
update:
x-apievangelist-phrasing:
intent: List a service's service roles
effect: read
questions:
- What service roles does this service define?
- Which roles can be granted to control access to a service's endpoints?
instructions:
- text: List the service roles defined by this service.
- text: Show me the service roles on the service.
- text: List the service roles that service {service} in {database}.{schema} defines.
slots:
database: path.database
schema: path.schema
service: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/services/{service}/roles/{name}/grants-of'].get
update:
x-apievangelist-phrasing:
intent: Show who holds a service role
effect: read
questions:
- Which account roles or users have been granted a particular service role?
- Who has been given this service role?
instructions:
- text: List who has been granted this service role on service {service}.
slots:
service: path.service
- text: Show the grants of the service role from {service}.
slots:
service: path.service
- text: Show who holds service role {role} of service {service} in {database}.{schema}.
slots:
database: path.database
schema: path.schema
service: path.service
role: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/services/{service}/roles/{name}/grants'].get
update:
x-apievangelist-phrasing:
intent: Show privileges granted to a service role
effect: read
questions:
- What privileges does a service role carry, such as access to endpoints?
- Which endpoints can a given service role reach?
instructions:
- text: List the privileges granted to this service role of {service}.
slots:
service: path.service
- text: Show what the service role on {service} is allowed to do.
slots:
service: path.service
- text: Show the privileges granted to service role {role} of service {service} in {database}.{schema}.
slots:
database: path.database
schema: path.schema
service: path.service
role: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/services/{name}:resume'].post
update:
x-apievangelist-phrasing:
intent: Resume a suspended service
effect: write
questions:
- How do I restart a service I suspended earlier?
- Can I bring a suspended container service back online?
instructions:
- text: Resume this service.
- text: Start the suspended service back up.
- text: Resume suspended service {service} in {database}.{schema}.
slots:
database: path.database
schema: path.schema
service: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/services/{name}:suspend'].post
update:
x-apievangelist-phrasing:
intent: Suspend a running service
effect: write
questions:
- How do I pause a container service to stop it using compute?
- Can I suspend a service without deleting it?
instructions:
- text: Suspend this service.
- text: Pause the running service for now.
- text: Suspend running service {service} in {database}.{schema}.
slots:
database: path.database
schema: path.schema
service: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/services/{name}/endpoints'].get
update:
x-apievangelist-phrasing:
intent: List a service's endpoints
effect: read
questions:
- What endpoints and ingress URLs does my service expose?
- Which ports and protocols is a job or container service listening on?
instructions:
- text: List the endpoints this service exposes.
- text: Show me the public ingress URLs for the service.
- text: Show the endpoints exposed by service {service} in {database}.{schema}.
slots:
database: path.database
schema: path.schema
service: path.name
method: generated
generated: '2026-10-01'