Snowflake · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snowflake Schema API

11 actions 11 updates phrasing extends openapi/snowflake-schema-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 11

$.info
$.paths['/api/v2/databases/{database}/schemas'].get
$.paths['/api/v2/databases/{database}/schemas'].post
$.paths['/api/v2/databases/{database}/schemas/{name}:clone'].post
$.paths['/api/v2/databases/{database}/schemas/{name}:undrop'].post
$.paths['/api/v2/databases/{database}/schemas/{name}'].get
$.paths['/api/v2/databases/{database}/schemas/{name}'].put
$.paths['/api/v2/databases/{database}/schemas/{name}'].delete
$.paths['/api/v2/databases/{database}/schemas/{name}:set-tags'].post
$.paths['/api/v2/databases/{database}/schemas/{name}:unset-tags'].post
$.paths['/api/v2/databases/{database}/schemas/{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 Schema API
  version: 1.0.0
extends: openapi/snowflake-schema-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: 10
- target: $.paths['/api/v2/databases/{database}/schemas'].get
  update:
    x-apievangelist-phrasing:
      intent: List schemas in a database
      effect: read
      questions:
      - Which schemas can I access in this database?
      - Can I include dropped schemas that haven't been purged yet?
      instructions:
      - text: List the schemas in database {database}.
        slots:
          database: path.database
      - text: List schemas here, including recently dropped ones ({history}).
        slots:
          history: query.history
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a schema
      effect: write
      questions:
      - How do I create a new schema in a database?
      - Can I make a transient schema or one with managed access?
      - Is it possible to set the data retention period when creating a schema?
      instructions:
      - text: Create a schema named {name} in database {database}.
        slots:
          name: requestBody.name
          database: path.database
      - text: Create a {kind} schema called {name}.
        slots:
          kind: query.kind
          name: requestBody.name
      - text: Create schema {name} with managed access {managed_access} and {data_retention_time_in_days} retention days.
        slots:
          name: requestBody.name
          managed_access: requestBody.managed_access
          data_retention_time_in_days: requestBody.data_retention_time_in_days
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{name}:clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a schema
      effect: write
      questions:
      - Can I zero-copy clone a whole schema into another database?
      - Is it possible to clone a schema as of an earlier point in time?
      instructions:
      - text: Clone schema {source} in database {database} as {name}.
        slots:
          source: path.name
          database: path.database
          name: requestBody.name
      - text: Clone this schema into database {targetDatabase} as {name}.
        slots:
          targetDatabase: query.targetDatabase
          name: requestBody.name
      - text: Clone this schema as {name} at {point_of_time}.
        slots:
          name: requestBody.name
          point_of_time: requestBody.point_of_time
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{name}:undrop'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a dropped schema
      effect: write
      questions:
      - Can I recover a schema I dropped by accident?
      - How do I undrop a schema within its retention window?
      instructions:
      - text: Undrop schema {name} in database {database}.
        slots:
          name: path.name
          database: path.database
      - text: Restore the schema I deleted by mistake.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe a single schema
      effect: read
      questions:
      - What retention, owner and settings does this schema have?
      - Can I look up one schema's full definition?
      instructions:
      - text: Describe schema {name} in database {database}.
        slots:
          name: path.name
          database: path.database
      - text: Fetch this schema's properties.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or alter a schema with a full definition
      effect: write
      questions:
      - Can I change a schema's settings by resubmitting its complete definition?
      - Why do I have to send the whole schema definition just to alter one property?
      instructions:
      - text: Create or update schema {name} in database {database} with comment {comment}.
        slots:
          name: path.name
          database: path.database
          comment: requestBody.comment
      - text: Alter schema {name} to use log level {log_level}, resending its full definition.
        slots:
          name: requestBody.name
          log_level: requestBody.log_level
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Drop a schema
      effect: destructive
      questions:
      - How do I drop a schema?
      - Can I refuse the drop if other objects still reference the schema?
      instructions:
      - text: Drop schema {name} from database {database}.
        slots:
          name: path.name
          database: path.database
      - text: Drop this schema only if nothing depends on it ({restrict}).
        slots:
          restrict: query.restrict
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{name}:set-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Set tags on a schema
      effect: write
      questions:
      - How do I tag a schema?
      - Can I label a schema with a data-domain tag?
      instructions:
      - text: Set tags on schema {database}.{name}.
        slots:
          database: path.database
          name: path.name
      - text: Apply my tag assignments to the schema I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{name}:unset-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from a schema
      effect: write
      questions:
      - Can I remove tags from a schema?
      - What's the way to clear a tag off a schema?
      instructions:
      - text: Unset the tags on schema {database}.{name}.
        slots:
          database: path.database
          name: path.name
      - text: Remove the tag assignments from the schema I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{name}:get-tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the tags assigned to a schema
      effect: read
      questions:
      - Which tags are assigned to this schema?
      - Does reading a schema's tags need an active warehouse?
      instructions:
      - text: Show every tag assigned to schema {database}.{name}.
        slots:
          database: path.database
          name: path.name
      - text: List the tag assignments on the schema I named.
      method: generated
      generated: '2026-10-01'