Snowflake · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snowflake Notification Integration API

8 actions 8 updates phrasing extends openapi/snowflake-notification-integration-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/notification-integrations'].get
$.paths['/api/v2/notification-integrations'].post
$.paths['/api/v2/notification-integrations/{name}'].get
$.paths['/api/v2/notification-integrations/{name}'].delete
$.paths['/api/v2/notification-integrations/{name}:set-tags'].post
$.paths['/api/v2/notification-integrations/{name}:unset-tags'].post
$.paths['/api/v2/notification-integrations/{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 Notification Integration API
  version: 1.0.0
extends: openapi/snowflake-notification-integration-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/notification-integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List notification integrations
      effect: read
      questions:
      - Which notification integrations exist in my Snowflake account?
      - Can I see all the integrations Snowflake uses to send alerts and emails?
      instructions:
      - text: List all notification integrations in the account.
      - text: Show me every configured notification integration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/notification-integrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a notification integration
      effect: write
      questions:
      - How do I set up an integration so Snowflake can send notifications to a queue, webhook or email?
      - Can I create a notification integration that starts out disabled?
      instructions:
      - text: Create notification integration {name} with hook {notification_hook}.
        slots:
          name: requestBody.name
          notification_hook: requestBody.notification_hook
      - text: Create notification integration {name} using {notification_hook} with enabled set to {enabled}.
        slots:
          name: requestBody.name
          notification_hook: requestBody.notification_hook
          enabled: requestBody.enabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/notification-integrations/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a notification integration
      effect: read
      questions:
      - Where does a particular notification integration send its messages?
      - Is a given notification integration enabled?
      instructions:
      - text: Fetch notification integration {name}.
        slots:
          name: path.name
      - text: Show the hook settings of this notification integration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/notification-integrations/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a notification integration
      effect: destructive
      questions:
      - How do I remove a notification integration?
      - What stops working if I drop a notification integration?
      instructions:
      - text: Delete notification integration {name}.
        slots:
          name: path.name
      - text: Drop this notification integration from the account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/notification-integrations/{name}:set-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Set tags on a notification integration
      effect: write
      questions:
      - How do I attach tags to a notification integration?
      - Can I label a notification integration with an owner tag?
      instructions:
      - text: Set tags on notification integration {name}.
        slots:
          name: path.name
      - text: Tag the notification integration I named with our owner tag.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/notification-integrations/{name}:unset-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from a notification integration
      effect: write
      questions:
      - How can I remove a tag from a notification integration?
      - Can I clear tag assignments on a notification integration?
      instructions:
      - text: Unset tags from notification integration {name}.
        slots:
          name: path.name
      - text: Remove the owner tag from the notification integration I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/notification-integrations/{name}:get-tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Get tag assignments for a notification integration
      effect: read
      questions:
      - Which tags are assigned to a notification integration?
      - Does reading a notification integration's tags need an active warehouse?
      instructions:
      - text: Show all tags assigned to notification integration {name}.
        slots:
          name: path.name
      - text: List the tag assignments on the notification integration I named.
      method: generated
      generated: '2026-10-01'