Snowflake · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snowflake User Defined Function API

10 actions 10 updates phrasing extends openapi/snowflake-user-defined-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 10

$.info
$.paths['/api/v2/databases/{database}/schemas/{schema}/user-defined-functions'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/user-defined-functions'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/user-defined-functions/{nameWithArgs}'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/user-defined-functions/{nameWithArgs}'].delete
$.paths['/api/v2/databases/{database}/schemas/{schema}/user-defined-functions/{name}:execute'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/user-defined-functions/{nameWithArgs}:rename'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/user-defined-functions/{nameWithArgs}:set-tags'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/user-defined-functions/{nameWithArgs}:unset-tags'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/user-defined-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 User Defined Function API
  version: 1.0.0
extends: openapi/snowflake-user-defined-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: 9
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/user-defined-functions'].get
  update:
    x-apievangelist-phrasing:
      intent: List user-defined functions in a schema
      effect: read
      questions:
      - Which UDFs are defined in this schema?
      - Can I see all my custom SQL and Python functions in one schema?
      instructions:
      - text: List all user-defined functions in schema {schema} of database {database}.
        slots:
          schema: path.schema
          database: path.database
      - text: Show me the UDFs defined here.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/user-defined-functions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user-defined function
      effect: write
      questions:
      - How do I create a custom function with its own arguments and return type?
      - Can I write a UDF in a language other than SQL, like Python or Java?
      - Is it possible to make a secure or memoizable UDF?
      instructions:
      - text: Create UDF {name} in {database}.{schema} taking {arguments}, returning {return_type}, using {language_config}.
        slots:
          name: requestBody.name
          database: path.database
          schema: path.schema
          arguments: requestBody.arguments
          return_type: requestBody.return_type
          language_config: requestBody.language_config
      - text: Create function {name}({arguments}) returning {return_type} in {language_config} with body {body}.
        slots:
          name: requestBody.name
          arguments: requestBody.arguments
          return_type: requestBody.return_type
          language_config: requestBody.language_config
          body: requestBody.body
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/user-defined-functions/{nameWithArgs}'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe a user-defined function
      effect: read
      questions:
      - What arguments, return type and language does this UDF use?
      - Can I look up one function's definition by its name and argument types?
      instructions:
      - text: Describe UDF {nameWithArgs} in {database}.{schema}.
        slots:
          nameWithArgs: path.nameWithArgs
          database: path.database
          schema: path.schema
      - text: Fetch this user-defined function's signature and body.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/user-defined-functions/{nameWithArgs}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Drop a user-defined function
      effect: destructive
      questions:
      - How do I drop a UDF I no longer use?
      - Do I need the argument types to delete an overloaded function?
      instructions:
      - text: Drop user-defined function {nameWithArgs} from {database}.{schema}.
        slots:
          nameWithArgs: path.nameWithArgs
          database: path.database
          schema: path.schema
      - text: Delete the UDF I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/user-defined-functions/{name}:execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Call a user-defined function
      effect: write
      questions:
      - Can I invoke a UDF directly over REST and get its result?
      - Is there a way to run a custom function without writing a SELECT?
      instructions:
      - text: Execute user-defined function {database}.{schema}.{name}.
        slots:
          database: path.database
          schema: path.schema
          name: path.name
      - text: Call the UDF I named and return its output.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/user-defined-functions/{nameWithArgs}:rename'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename or move a user-defined function
      effect: write
      questions:
      - How do I rename a UDF?
      - Can I move a function to another database and schema?
      instructions:
      - text: Rename UDF {database}.{schema}.{nameWithArgs} to {targetName} in {targetDatabase}.{targetSchema}.
        slots:
          database: path.database
          schema: path.schema
          nameWithArgs: path.nameWithArgs
          targetName: query.targetName
          targetDatabase: query.targetDatabase
          targetSchema: query.targetSchema
      - text: Move this function into schema {targetSchema} of database {targetDatabase}, calling it {targetName}.
        slots:
          targetSchema: query.targetSchema
          targetDatabase: query.targetDatabase
          targetName: query.targetName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/user-defined-functions/{nameWithArgs}:set-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Set tags on a user-defined function
      effect: write
      questions:
      - How do I tag a UDF?
      - Can I label a custom function with an owner tag?
      instructions:
      - text: Set tags on user-defined function {database}.{schema}.{nameWithArgs}.
        slots:
          database: path.database
          schema: path.schema
          nameWithArgs: path.nameWithArgs
      - text: Apply my tag assignments to the UDF I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/user-defined-functions/{nameWithArgs}:unset-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from a user-defined function
      effect: write
      questions:
      - Can I remove tags from a UDF?
      - What's the way to clear a tag off a custom function?
      instructions:
      - text: Unset the tags on user-defined function {database}.{schema}.{nameWithArgs}.
        slots:
          database: path.database
          schema: path.schema
          nameWithArgs: path.nameWithArgs
      - text: Remove the tag assignments from the UDF I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/user-defined-functions/{nameWithArgs}:get-tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the tags assigned to a user-defined function
      effect: read
      questions:
      - Which tags are assigned to this UDF?
      - Does reading a function's tags need an active warehouse?
      instructions:
      - text: Show every tag assigned to user-defined function {database}.{schema}.{nameWithArgs}.
        slots:
          database: path.database
          schema: path.schema
          nameWithArgs: path.nameWithArgs
      - text: List the tag assignments on the UDF I named.
      method: generated
      generated: '2026-10-01'