Snowflake · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snowflake Tag API

8 actions 8 updates phrasing extends openapi/snowflake-tag-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 8

$.info
$.paths['/api/v2/databases/{database}/schemas/{schema}/tags'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/tags'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/tags/{name}'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/tags/{name}'].put
$.paths['/api/v2/databases/{database}/schemas/{schema}/tags/{name}'].delete
$.paths['/api/v2/databases/{database}/schemas/{schema}/tags/{name}:undrop'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/tags/{name}:rename'].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 Tag API
  version: 1.0.0
extends: openapi/snowflake-tag-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: 7
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List tag definitions in a schema
      effect: read
      questions:
      - Which governance tags are defined in this schema?
      - Can I list every tag object under a database and schema?
      instructions:
      - text: List the tags defined in schema {schema} of database {database}.
        slots:
          database: path.database
          schema: path.schema
      - text: Show me all tag objects created here.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a tag
      effect: write
      questions:
      - How do I create a tag that only accepts a fixed list of values?
      - Can a new tag propagate automatically to downstream objects?
      instructions:
      - text: Create a tag named {name} in {database}.{schema}.
        slots:
          name: requestBody.name
          database: path.database
          schema: path.schema
      - text: Create tag {name} limited to the values {allowed_values}.
        slots:
          name: requestBody.name
          allowed_values: requestBody.allowed_values
      - text: Create tag {name} with propagation set to {propagate}.
        slots:
          name: requestBody.name
          propagate: requestBody.propagate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/tags/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the definition of a tag
      effect: read
      questions:
      - What allowed values and propagation setting does a particular tag have?
      - Who owns a given tag object?
      instructions:
      - text: Show me the definition of tag {tag} in {database}.{schema}.
        slots:
          tag: path.name
          database: path.database
          schema: path.schema
      - text: Fetch the tag's allowed values and owner.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/tags/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a tag definition
      effect: write
      questions:
      - Can I change an existing tag's allowed values by resending its definition?
      - Which call creates a tag if missing or updates it if it already exists?
      instructions:
      - text: Create or update tag {tag} in {database}.{schema} so its allowed values are {allowed_values}.
        slots:
          tag: path.name
          database: path.database
          schema: path.schema
          allowed_values: requestBody.allowed_values
      - text: Update tag {name} with the comment {comment}, creating it if needed.
        slots:
          name: requestBody.name
          comment: requestBody.comment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/tags/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Drop a tag
      effect: destructive
      questions:
      - How do I drop a tag we no longer use?
      - Can a tag object be deleted through the API?
      instructions:
      - text: Drop tag {tag} from {database}.{schema}.
        slots:
          tag: path.name
          database: path.database
          schema: path.schema
      - text: Delete the tag object.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/tags/{name}:undrop'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a dropped tag
      effect: write
      questions:
      - Can I bring back a tag I dropped by mistake?
      - Is there a way to undrop a tag?
      instructions:
      - text: Undrop tag {tag} in {database}.{schema}.
        slots:
          tag: path.name
          database: path.database
          schema: path.schema
      - text: Restore the tag I just dropped.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/tags/{name}:rename'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename or move a tag
      effect: write
      questions:
      - Can I rename a tag without recreating it?
      - Is it possible to move a tag into a different database or schema?
      instructions:
      - text: Rename tag {tag} in {database}.{schema} to {new_name}.
        slots:
          tag: path.name
          database: path.database
          schema: path.schema
          new_name: query.targetName
      - text: Move the tag to {database}.{schema} as {new_name}.
        slots:
          database: query.targetDatabase
          schema: query.targetSchema
          new_name: query.targetName
      method: generated
      generated: '2026-10-01'