Snowflake · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snowflake Procedure API

9 actions 9 updates phrasing extends openapi/snowflake-procedure-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}/procedures'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/procedures'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/procedures/{nameWithArgs}'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/procedures/{nameWithArgs}'].delete
$.paths['/api/v2/databases/{database}/schemas/{schema}/procedures/{nameWithArgs}:call'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/procedures/{nameWithArgs}:set-tags'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/procedures/{nameWithArgs}:unset-tags'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/procedures/{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 Procedure API
  version: 1.0.0
extends: openapi/snowflake-procedure-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}/procedures'].get
  update:
    x-apievangelist-phrasing:
      intent: List stored procedures in a schema
      effect: read
      questions:
      - Which stored procedures are defined in this schema?
      - Can I list every procedure under a database and schema?
      instructions:
      - text: List the stored procedures in schema {schema} of database {database}.
        slots:
          database: path.database
          schema: path.schema
      - text: Show me all procedures defined here.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/procedures'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a stored procedure
      effect: write
      questions:
      - How do I create a stored procedure with its arguments, return type and language?
      - Can a new procedure run with the caller's rights instead of the owner's?
      - Is it possible to mark a procedure as secure when I create it?
      instructions:
      - text: Create procedure {name} in {database}.{schema} taking {arguments}, returning {return_type}, written in {language}.
        slots:
          name: requestBody.name
          arguments: requestBody.arguments
          return_type: requestBody.return_type
          language: requestBody.language_config
          database: path.database
          schema: path.schema
      - text: Create procedure {name} ({arguments}) returning {return_type} in {language} with body {body}.
        slots:
          name: requestBody.name
          arguments: requestBody.arguments
          return_type: requestBody.return_type
          language: requestBody.language_config
          body: requestBody.body
      - text: Create procedure {name} with args {arguments}, return {return_type}, language {language}, executing as {execute_as}.
        slots:
          name: requestBody.name
          arguments: requestBody.arguments
          return_type: requestBody.return_type
          language: requestBody.language_config
          execute_as: requestBody.execute_as
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/procedures/{nameWithArgs}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the definition of a stored procedure
      effect: read
      questions:
      - What arguments, return type and body does a particular procedure have?
      - Where can I read one stored procedure's full definition?
      instructions:
      - text: Show me the definition of stored procedure {procedure} (name with argument types) in {database}.{schema}.
        slots:
          procedure: path.nameWithArgs
          database: path.database
          schema: path.schema
      - text: Fetch the procedure's signature and body.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/procedures/{nameWithArgs}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Drop a stored procedure
      effect: destructive
      questions:
      - How do I drop a stored procedure I no longer need?
      - Can a procedure be deleted by its name and argument types?
      instructions:
      - text: Drop stored procedure {procedure} (name with argument types) from {database}.{schema}.
        slots:
          procedure: path.nameWithArgs
          database: path.database
          schema: path.schema
      - text: Delete the procedure permanently.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/procedures/{nameWithArgs}:call'].post
  update:
    x-apievangelist-phrasing:
      intent: Call a stored procedure
      effect: write
      questions:
      - How do I execute a stored procedure over REST and get its result back?
      - Can I pass arguments when calling a procedure through the API?
      instructions:
      - text: Call procedure {procedure} in {database}.{schema} with arguments {call_arguments}.
        slots:
          procedure: path.nameWithArgs
          database: path.database
          schema: path.schema
          call_arguments: requestBody.call_arguments
      - text: Run the stored procedure passing {call_arguments} and show me what it returns.
        slots:
          call_arguments: requestBody.call_arguments
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/procedures/{nameWithArgs}:set-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach tags to a stored procedure
      effect: write
      questions:
      - How do I apply governance tags to a stored procedure?
      - Can I set tag values on a procedure?
      instructions:
      - text: Set tags on stored procedure {procedure} in {database}.{schema}.
        slots:
          procedure: path.nameWithArgs
          database: path.database
          schema: path.schema
      - text: Tag the procedure with its owning team.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/procedures/{nameWithArgs}:unset-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from a stored procedure
      effect: write
      questions:
      - How do I remove a tag from a stored procedure?
      - Can I clear tag assignments on a procedure without dropping the tag?
      instructions:
      - text: Unset the tags on stored procedure {procedure} in {database}.{schema}.
        slots:
          procedure: path.nameWithArgs
          database: path.database
          schema: path.schema
      - text: Strip the tag assignments off the procedure.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/procedures/{nameWithArgs}:get-tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the tags assigned to a stored procedure
      effect: read
      questions:
      - Which tags are assigned to this stored procedure?
      - Does reading a procedure's tags need an active warehouse?
      instructions:
      - text: Show every tag assigned to stored procedure {procedure} in {database}.{schema}.
        slots:
          procedure: path.nameWithArgs
          database: path.database
          schema: path.schema
      - text: Get the procedure's current tag assignments.
      method: generated
      generated: '2026-10-01'