Snowflake · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snowflake API Integration API

9 actions 9 updates phrasing extends openapi/snowflake-api-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 9

$.info
$.paths['/api/v2/api-integrations'].get
$.paths['/api/v2/api-integrations'].post
$.paths['/api/v2/api-integrations/{name}'].get
$.paths['/api/v2/api-integrations/{name}'].put
$.paths['/api/v2/api-integrations/{name}'].delete
$.paths['/api/v2/api-integrations/{name}:set-tags'].post
$.paths['/api/v2/api-integrations/{name}:unset-tags'].post
$.paths['/api/v2/api-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 API Integration API
  version: 1.0.0
extends: openapi/snowflake-api-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: 8
- target: $.paths['/api/v2/api-integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List API integrations
      effect: read
      questions:
      - Which API integrations are configured in my Snowflake account?
      - Can I see all the integrations used for external functions and Git access?
      instructions:
      - text: List all API integrations in the account.
      - text: Show me every configured API integration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/api-integrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API integration
      effect: write
      questions:
      - How do I set up an API integration so Snowflake can call an external endpoint?
      - Can I block certain URL prefixes when creating an API integration?
      instructions:
      - text: Create API integration {name} with hook {api_hook} allowing prefixes {api_allowed_prefixes}, enabled {enabled}.
        slots:
          name: requestBody.name
          api_hook: requestBody.api_hook
          api_allowed_prefixes: requestBody.api_allowed_prefixes
          enabled: requestBody.enabled
      - text: Create integration {name} using {api_hook}, allowing {api_allowed_prefixes} but blocking {api_blocked_prefixes}.
        slots:
          name: requestBody.name
          api_hook: requestBody.api_hook
          api_allowed_prefixes: requestBody.api_allowed_prefixes
          api_blocked_prefixes: requestBody.api_blocked_prefixes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/api-integrations/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API integration
      effect: read
      questions:
      - What allowed prefixes and hook does a given API integration use?
      - Is a particular API integration enabled?
      instructions:
      - text: Fetch API integration {integration}.
        slots:
          integration: path.name
      - text: Show the hook and allowed prefixes of this API integration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/api-integrations/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update an API integration
      effect: write
      questions:
      - Can I change the allowed prefixes on an existing API integration?
      - Does updating an API integration also change its API key?
      instructions:
      - text: Create or alter API integration {integration} to allow prefixes {api_allowed_prefixes}.
        slots:
          integration: path.name
          api_allowed_prefixes: requestBody.api_allowed_prefixes
      - text: Update integration {name} with hook {api_hook} and set enabled to {enabled}.
        slots:
          name: requestBody.name
          api_hook: requestBody.api_hook
          enabled: requestBody.enabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/api-integrations/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API integration
      effect: destructive
      questions:
      - How do I remove an API integration I no longer use?
      - What breaks if I drop an API integration?
      instructions:
      - text: Delete API integration {integration}.
        slots:
          integration: path.name
      - text: Drop this API integration from the account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/api-integrations/{name}:set-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Set tags on an API integration
      effect: write
      questions:
      - How do I attach tags to an API integration?
      - Can I label an API integration with an owner tag?
      instructions:
      - text: Set tags on API integration {integration}.
        slots:
          integration: path.name
      - text: Tag the API integration I named with our owner tag.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/api-integrations/{name}:unset-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from an API integration
      effect: write
      questions:
      - How can I remove a tag from an API integration?
      - Can I clear tag assignments on an API integration?
      instructions:
      - text: Unset tags from API integration {integration}.
        slots:
          integration: path.name
      - text: Remove the owner tag from the API integration I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/api-integrations/{name}:get-tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Get tag assignments for an API integration
      effect: read
      questions:
      - Which tags are assigned to an API integration?
      - Does reading an API integration's tags need an active warehouse?
      instructions:
      - text: Show all tags assigned to API integration {integration}.
        slots:
          integration: path.name
      - text: List the tag assignments on the API integration I named.
      method: generated
      generated: '2026-10-01'