Snowflake · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snowflake Alert API

10 actions 10 updates phrasing extends openapi/snowflake-alert-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}/alerts'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/alerts'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/alerts/{name}'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/alerts/{name}'].delete
$.paths['/api/v2/databases/{database}/schemas/{schema}/alerts/{name}:clone'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/alerts/{name}:execute'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/alerts/{name}:set-tags'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/alerts/{name}:unset-tags'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/alerts/{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 Alert API
  version: 1.0.0
extends: openapi/snowflake-alert-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}/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List alerts in a schema
      effect: read
      questions:
      - Which alerts are defined in this schema?
      - Can I see all my Snowflake alerts in one place?
      instructions:
      - text: List all alerts in schema {schema} of database {database}.
        slots:
          schema: path.schema
          database: path.database
      - text: Show me the alerts defined here.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an alert
      effect: write
      questions:
      - How do I get notified when a query condition becomes true on a schedule?
      - 'What does an alert need: a schedule, a condition and an action?'
      - Can I pick which warehouse evaluates an alert's condition?
      instructions:
      - text: Create alert {name} in {database}.{schema} that checks {condition} on {schedule} and runs {action}.
        slots:
          name: requestBody.name
          database: path.database
          schema: path.schema
          condition: requestBody.condition
          schedule: requestBody.schedule
          action: requestBody.action
      - text: Create alert {name} on warehouse {warehouse} checking {condition} every {schedule}, then {action}.
        slots:
          name: requestBody.name
          warehouse: requestBody.warehouse
          condition: requestBody.condition
          schedule: requestBody.schedule
          action: requestBody.action
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/alerts/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe a single alert
      effect: read
      questions:
      - What condition, schedule and action does this alert use?
      - Is this alert currently started or suspended?
      instructions:
      - text: Describe alert {name} in {database}.{schema}.
        slots:
          name: path.name
          database: path.database
          schema: path.schema
      - text: Fetch this alert's definition and state.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/alerts/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an alert
      effect: destructive
      questions:
      - How do I drop an alert I no longer need?
      - Can an alert be deleted through the API?
      instructions:
      - text: Drop alert {name} from {database}.{schema}.
        slots:
          name: path.name
          database: path.database
          schema: path.schema
      - text: Delete the alert I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/alerts/{name}:clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone an alert into a schema
      effect: write
      questions:
      - Can I copy an existing alert into another database and schema?
      - Is it possible to clone an alert as of an earlier point in time?
      instructions:
      - text: Clone alert {database}.{schema}.{source} as {name} into {targetDatabase}.{targetSchema}.
        slots:
          database: path.database
          schema: path.schema
          source: path.name
          name: requestBody.name
          targetDatabase: query.targetDatabase
          targetSchema: query.targetSchema
      - text: Clone this alert as {name} into {targetDatabase}.{targetSchema} as of {point_of_time}.
        slots:
          name: requestBody.name
          targetDatabase: query.targetDatabase
          targetSchema: query.targetSchema
          point_of_time: requestBody.point_of_time
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/alerts/{name}:execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run an alert now
      effect: write
      questions:
      - Can I evaluate an alert immediately instead of waiting for its schedule?
      - Is there a way to test-fire an alert on demand?
      instructions:
      - text: Execute alert {database}.{schema}.{name} now.
        slots:
          database: path.database
          schema: path.schema
          name: path.name
      - text: Run the alert I named immediately.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/alerts/{name}:set-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Set tags on an alert
      effect: write
      questions:
      - How do I tag an alert?
      - Can I label an alert with an on-call team tag?
      instructions:
      - text: Set tags on alert {database}.{schema}.{name}.
        slots:
          database: path.database
          schema: path.schema
          name: path.name
      - text: Apply my tag assignments to the alert I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/alerts/{name}:unset-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from an alert
      effect: write
      questions:
      - Can I remove tags from an alert?
      - What's the way to clear a tag off an alert?
      instructions:
      - text: Unset the tags on alert {database}.{schema}.{name}.
        slots:
          database: path.database
          schema: path.schema
          name: path.name
      - text: Remove the tag assignments from the alert I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/alerts/{name}:get-tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the tags assigned to an alert
      effect: read
      questions:
      - Which tags are assigned to this alert?
      - Does reading an alert's tags need an active warehouse?
      instructions:
      - text: Show every tag assigned to alert {database}.{schema}.{name}.
        slots:
          database: path.database
          schema: path.schema
          name: path.name
      - text: List the tag assignments on the alert I named.
      method: generated
      generated: '2026-10-01'