Snowflake · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snowflake Function API

9 actions 9 updates phrasing extends openapi/snowflake-function-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 9

$.info
$.paths['/api/v2/databases/{database}/schemas/{schema}/functions'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/functions'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/functions/{nameWithArgs}'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/functions/{nameWithArgs}'].delete
$.paths['/api/v2/databases/{database}/schemas/{schema}/functions/{name}:execute'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/functions/{nameWithArgs}:set-tags'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/functions/{nameWithArgs}:unset-tags'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/functions/{nameWithArgs}: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 Function API
  version: 1.0.0
extends: openapi/snowflake-function-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: 8
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/functions'].get
  update:
    x-apievangelist-phrasing:
      intent: List user functions in a schema
      effect: read
      questions:
      - Which user-defined functions exist in this schema?
      - Can I see all the functions defined under a database and schema?
      instructions:
      - text: List the user functions in schema {schema} of database {database}.
        slots:
          database: path.database
          schema: path.schema
      - text: Show me every function defined in the schema I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/functions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a function
      effect: write
      questions:
      - How do I define a new function in a Snowflake schema?
      - Can I set the language, return type and body when creating a function?
      instructions:
      - text: Create function {name} in {database}.{schema} that takes arguments {arguments}.
        slots:
          name: requestBody.name
          arguments: requestBody.arguments
          database: path.database
          schema: path.schema
      - text: Create {language} function {name} with arguments {arguments} returning {returns} and body {body}.
        slots:
          language: requestBody.language
          name: requestBody.name
          arguments: requestBody.arguments
          returns: requestBody.returns
          body: requestBody.body
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/functions/{nameWithArgs}'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe a function
      effect: read
      questions:
      - What signature and return type does a specific function have?
      - Can I see the describe output for one function by its name and arguments?
      instructions:
      - text: Describe function {function} (name with argument types) in {database}.{schema}.
        slots:
          function: path.nameWithArgs
          database: path.database
          schema: path.schema
      - text: Show the definition of this function.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/functions/{nameWithArgs}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a function
      effect: destructive
      questions:
      - How do I drop a function with a specific argument signature?
      - Do I need the argument types to delete an overloaded function?
      instructions:
      - text: Delete function {function} (name with argument types) from {database}.{schema}.
        slots:
          function: path.nameWithArgs
          database: path.database
          schema: path.schema
      - text: Drop this function from the schema.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/functions/{name}:execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Execute a function
      effect: write
      questions:
      - Can I call a Snowflake function over REST and get its result?
      - What does running a function through the API return?
      instructions:
      - text: Execute function {function} in {database}.{schema} with these argument values.
        slots:
          function: path.name
          database: path.database
          schema: path.schema
      - text: Run this function and return its result.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/functions/{nameWithArgs}:set-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Set tags on a function
      effect: write
      questions:
      - How do I attach tags to a function?
      - Can I label a function with a data domain tag?
      instructions:
      - text: Set tags on function {function} in {database}.{schema}.
        slots:
          function: path.nameWithArgs
          database: path.database
          schema: path.schema
      - text: Tag the function I named with our data domain.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/functions/{nameWithArgs}:unset-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from a function
      effect: write
      questions:
      - How can I remove a tag from a function?
      - Can I clear tag assignments on a function?
      instructions:
      - text: Unset tags from function {function} in {database}.{schema}.
        slots:
          function: path.nameWithArgs
          database: path.database
          schema: path.schema
      - text: Remove the data domain tag from the function I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/functions/{nameWithArgs}:get-tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Get tag assignments for a function
      effect: read
      questions:
      - Which tags are assigned to a function?
      - Does reading a function's tags require an active warehouse?
      instructions:
      - text: Show all tags assigned to function {function} in {database}.{schema}.
        slots:
          function: path.nameWithArgs
          database: path.database
          schema: path.schema
      - text: List the tag assignments on the function I named.
      method: generated
      generated: '2026-10-01'