Snowflake · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snowflake Event Table API

9 actions 9 updates phrasing extends openapi/snowflake-event-table-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}/event-tables'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/event-tables'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/event-tables/{name}'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/event-tables/{name}'].delete
$.paths['/api/v2/databases/{database}/schemas/{schema}/event-tables/{name}:rename'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/event-tables/{name}:set-tags'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/event-tables/{name}:unset-tags'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/event-tables/{name}: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 Event Table API
  version: 1.0.0
extends: openapi/snowflake-event-table-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}/event-tables'].get
  update:
    x-apievangelist-phrasing:
      intent: List event tables in a schema
      effect: read
      questions:
      - Which event tables exist in this schema for logs and traces?
      - Can I list all event tables under a database and schema?
      instructions:
      - text: List the event tables in schema {schema} of database {database}.
        slots:
          database: path.database
          schema: path.schema
      - text: Show me every event table defined here.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/event-tables'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an event table
      effect: write
      questions:
      - How do I create an event table to collect logs and trace events?
      - Can I turn on change tracking when creating an event table?
      instructions:
      - text: Create an event table named {name} in {database}.{schema}.
        slots:
          name: requestBody.name
          database: path.database
          schema: path.schema
      - text: Create event table {name} with {days} days of data retention.
        slots:
          name: requestBody.name
          days: requestBody.data_retention_time_in_days
      - text: Create event table {name} with change tracking {change_tracking}.
        slots:
          name: requestBody.name
          change_tracking: requestBody.change_tracking
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/event-tables/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the details of an event table
      effect: read
      questions:
      - What columns, row count and retention does a given event table have?
      - Where can I read one event table's definition?
      instructions:
      - text: Show me the details of event table {table} in {database}.{schema}.
        slots:
          table: path.name
          database: path.database
          schema: path.schema
      - text: Fetch the event table's columns and settings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/event-tables/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Drop an event table
      effect: destructive
      questions:
      - How do I drop an event table I no longer need?
      - Can an event table be deleted through the API?
      instructions:
      - text: Drop event table {table} from {database}.{schema}.
        slots:
          table: path.name
          database: path.database
          schema: path.schema
      - text: Delete the event table permanently.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/event-tables/{name}:rename'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename an event table
      effect: write
      questions:
      - Can I rename an event table without recreating it?
      - How do I give an event table a new name?
      instructions:
      - text: Rename event table {table} in {database}.{schema} to {new_name}.
        slots:
          table: path.name
          database: path.database
          schema: path.schema
          new_name: query.targetName
      - text: Change the event table's name to {new_name}.
        slots:
          new_name: query.targetName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/event-tables/{name}:set-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach tags to an event table
      effect: write
      questions:
      - How do I apply governance tags to an event table?
      - Can I set tag values on an event table?
      instructions:
      - text: Set tags on event table {table} in {database}.{schema}.
        slots:
          table: path.name
          database: path.database
          schema: path.schema
      - text: Tag the event table with our sensitivity value.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/event-tables/{name}:unset-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from an event table
      effect: write
      questions:
      - How do I remove a tag from an event table?
      - Can I clear tag assignments on an event table without dropping the tag?
      instructions:
      - text: Unset the tags on event table {table} in {database}.{schema}.
        slots:
          table: path.name
          database: path.database
          schema: path.schema
      - text: Strip the tag assignments off the event table.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/event-tables/{name}:get-tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the tags assigned to an event table
      effect: read
      questions:
      - Which tags are assigned to this event table?
      - Does reading an event table's tags need an active warehouse?
      instructions:
      - text: Show every tag assigned to event table {table} in {database}.{schema}.
        slots:
          table: path.name
          database: path.database
          schema: path.schema
      - text: Get the event table's current tag assignments.
      method: generated
      generated: '2026-10-01'