Snowflake · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snowflake Streamlit API

17 actions 17 updates phrasing extends openapi/snowflake-streamlit-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 17 · first 16 shown; the file carries all of them

$.info
$.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}'].delete
$.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:undrop'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:rename'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:add-live-version'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:commit'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:add-version'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:add-version-from-git'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:abort'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:pull'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:push'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:set-tags'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:unset-tags'].post

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 Streamlit API
  version: 1.0.0
extends: openapi/snowflake-streamlit-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}/streamlits'].get
  update:
    x-apievangelist-phrasing:
      intent: List Streamlit apps in a schema
      effect: read
      questions:
      - Which Streamlit apps exist in this Snowflake schema?
      - Can I filter the Streamlit apps in a schema by a name pattern?
      instructions:
      - text: List all Streamlit apps in this schema.
      - text: Show me the Streamlits whose names match sales.
      - text: List the Streamlit apps 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}/streamlits'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a Streamlit app
      effect: write
      questions:
      - How do I deploy a new Streamlit app inside a Snowflake schema?
      - Can I set the main file and query warehouse when creating a Streamlit?
      instructions:
      - text: Create a Streamlit app named {name} with main file {main_file}.
        slots:
          name: requestBody.name
          main_file: requestBody.main_file
      - text: Create Streamlit {name} titled {title} from {source_location} running on warehouse {query_warehouse}.
        slots:
          name: requestBody.name
          title: requestBody.title
          source_location: requestBody.source_location
          query_warehouse: requestBody.query_warehouse
      - text: In {database}.{schema}, create Streamlit app {name} with main file {main_file}.
        slots:
          database: path.database
          schema: path.schema
          name: requestBody.name
          main_file: requestBody.main_file
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a Streamlit app
      effect: read
      questions:
      - What version and configuration is a particular Streamlit app running?
      - Where can I see the metadata and version details of one Streamlit?
      instructions:
      - text: Fetch the details of the Streamlit I named.
      - text: Show the default and last version details for this Streamlit app.
      - text: Get the details of Streamlit {streamlit} in {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          streamlit: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Streamlit app
      effect: destructive
      questions:
      - How do I remove a Streamlit app from Snowflake?
      - If I delete a Streamlit, can it be restored later?
      instructions:
      - text: Delete the Streamlit app I named.
      - text: Drop this Streamlit from the schema.
      - text: Delete Streamlit {streamlit} from schema {schema} in database {database}.
        slots:
          database: path.database
          schema: path.schema
          streamlit: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:undrop'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a deleted Streamlit app
      effect: write
      questions:
      - Can I bring back a Streamlit app I deleted by accident?
      - Is it possible to undrop a Streamlit within the retention period?
      instructions:
      - text: Undrop the Streamlit app I deleted.
      - text: Restore this recently dropped Streamlit.
      - text: Undrop Streamlit {streamlit} in schema {schema} of database {database}.
        slots:
          database: path.database
          schema: path.schema
          streamlit: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:rename'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename or move a Streamlit app
      effect: write
      questions:
      - How do I give a Streamlit app a new name?
      - Can I move a Streamlit into a different database or schema?
      instructions:
      - text: Rename this Streamlit to {targetName}.
        slots:
          targetName: query.targetName
      - text: Move the Streamlit to {targetDatabase}.{targetSchema} as {targetName}.
        slots:
          targetDatabase: query.targetDatabase
          targetSchema: query.targetSchema
          targetName: query.targetName
      - text: Rename Streamlit {streamlit} in {database}.{schema} to {targetName}.
        slots:
          database: path.database
          schema: path.schema
          streamlit: path.name
          targetName: query.targetName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:add-live-version'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a live version to a Streamlit app
      effect: write
      questions:
      - How do I make a specific version of a Streamlit the live one users see?
      - Can I create the live version from the last committed version?
      instructions:
      - text: Add a live version to this Streamlit from version {version}.
        slots:
          version: requestBody.version
      - text: Create the Streamlit's live version from the last version, with from-last set to {fromLast}.
        slots:
          fromLast: query.fromLast
      - text: Add a live version to Streamlit {streamlit} in {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          streamlit: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:commit'].post
  update:
    x-apievangelist-phrasing:
      intent: Commit a Streamlit's live version to Git
      effect: write
      questions:
      - How do I commit the live version of a Git-connected Streamlit?
      - Can I save the current live edits of a Streamlit as a named version?
      instructions:
      - text: Commit the live version of this Streamlit.
      - text: Commit the Streamlit's live version as {version}.
        slots:
          version: requestBody.version
      - text: Commit the live version of Streamlit {streamlit} in {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          streamlit: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:add-version'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a Streamlit version from a stage
      effect: write
      questions:
      - How can I publish a new Streamlit version from files on a stage?
      - Which stage location does a new Streamlit version copy its files from?
      instructions:
      - text: Add a new version to this Streamlit from stage location {source_location}.
        slots:
          source_location: requestBody.source_location
      - text: Copy files from {source_location} into Streamlit version {version}.
        slots:
          source_location: requestBody.source_location
          version: requestBody.version
      - text: Add a version to Streamlit {streamlit} in {database}.{schema} from stage {source_location}.
        slots:
          database: path.database
          schema: path.schema
          streamlit: path.name
          source_location: requestBody.source_location
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:add-version-from-git'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a Streamlit version from a Git reference
      effect: write
      questions:
      - Can I create a Streamlit version from a Git tag or commit?
      - What Git reference URI does Snowflake accept for a new Streamlit version?
      instructions:
      - text: Add version {version} to this Streamlit from Git ref {git_ref}.
        slots:
          version: requestBody.version
          git_ref: requestBody.git_ref
      - text: Build Streamlit version {version} from the Git commit at {git_ref}.
        slots:
          version: requestBody.version
          git_ref: requestBody.git_ref
      - text: Add version {version} to Streamlit {streamlit} in {database}.{schema} from Git ref {git_ref}.
        slots:
          database: path.database
          schema: path.schema
          streamlit: path.name
          version: requestBody.version
          git_ref: requestBody.git_ref
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:abort'].post
  update:
    x-apievangelist-phrasing:
      intent: Abort a Streamlit's live version
      effect: destructive
      questions:
      - How do I throw away uncommitted changes in a Streamlit's live version?
      - Can I abort the live version of a Git-connected Streamlit?
      instructions:
      - text: Abort the live version of this Streamlit.
      - text: Discard the uncommitted live changes on the Streamlit I named.
      - text: Abort the live version of Streamlit {streamlit} in {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          streamlit: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:pull'].post
  update:
    x-apievangelist-phrasing:
      intent: Pull latest Git changes into a Streamlit
      effect: write
      questions:
      - How do I update a Streamlit with the newest changes from its Git repository?
      - Can a Git-integrated Streamlit pull upstream commits?
      instructions:
      - text: Pull the latest Git changes into this Streamlit.
      - text: Sync the Streamlit I named from its Git repository.
      - text: Pull the latest Git changes into Streamlit {streamlit} in {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          streamlit: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:push'].post
  update:
    x-apievangelist-phrasing:
      intent: Push a Streamlit's commits to Git
      effect: write
      questions:
      - How do I push committed Streamlit changes back to the connected Git repository?
      - Which auth type can I use when pushing a Streamlit to Git?
      instructions:
      - text: Push this Streamlit's committed changes to its Git repository.
      - text: Push the Streamlit to Git using auth type {auth_type}.
        slots:
          auth_type: requestBody.auth_type
      - text: Push the commits of Streamlit {streamlit} in {database}.{schema} to Git.
        slots:
          database: path.database
          schema: path.schema
          streamlit: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:set-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Set tags on a Streamlit app
      effect: write
      questions:
      - How do I attach governance tags to a Streamlit app?
      - Can I label a Streamlit with an owner team tag?
      instructions:
      - text: Set tags on this Streamlit.
      - text: Tag the Streamlit app I named with our team tag.
      - text: Set tags on Streamlit {streamlit} in {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          streamlit: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:unset-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from a Streamlit app
      effect: write
      questions:
      - How can I remove a tag from a Streamlit app?
      - Can I clear tag assignments on a Streamlit?
      instructions:
      - text: Unset tags from this Streamlit.
      - text: Remove the team tag from the Streamlit app I named.
      - text: Unset tags on Streamlit {streamlit} in {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          streamlit: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streamlits/{name}:get-tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Get tag assignments for a Streamlit app
      effect: read
      questions:
      - Which tags are assigned to a Streamlit app?
      - Does reading a Streamlit's tags need an active warehouse?
      instructions:
      - text: Show all tags assigned to this Streamlit.
      - text: List the tag assignments on the Streamlit app I named.
      - text: Get the tags assigned to Streamlit {streamlit} in {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          streamlit: path.name
      method: generated
      generated: '2026-10-01'