Snowflake · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snowflake Catalog Integration API

8 actions 8 updates phrasing extends openapi/snowflake-catalog-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/catalog-integrations'].get
$.paths['/api/v2/catalog-integrations'].post
$.paths['/api/v2/catalog-integrations/{name}'].get
$.paths['/api/v2/catalog-integrations/{name}'].delete
$.paths['/api/v2/catalog-integrations/{name}:set-tags'].post
$.paths['/api/v2/catalog-integrations/{name}:unset-tags'].post
$.paths['/api/v2/catalog-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 Catalog Integration API
  version: 1.0.0
extends: openapi/snowflake-catalog-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/catalog-integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List catalog integrations
      effect: read
      questions:
      - Which external Iceberg catalog integrations are set up in my account?
      - Can I see all catalog integrations Snowflake knows about?
      instructions:
      - text: List all catalog integrations in the account.
      - text: Show me every configured catalog integration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/catalog-integrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a catalog integration
      effect: write
      questions:
      - How do I connect Snowflake to an external Iceberg catalog?
      - Which table format and catalog settings does a new catalog integration need?
      instructions:
      - text: Create catalog integration {name} for {table_format} tables using catalog {catalog}, enabled {enabled}.
        slots:
          name: requestBody.name
          table_format: requestBody.table_format
          catalog: requestBody.catalog
          enabled: requestBody.enabled
      - text: Set up an enabled catalog integration {name} pointing at {catalog} with format {table_format} and comment {comment}.
        slots:
          name: requestBody.name
          catalog: requestBody.catalog
          table_format: requestBody.table_format
          comment: requestBody.comment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/catalog-integrations/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a catalog integration
      effect: read
      questions:
      - What catalog and table format does a specific catalog integration use?
      - Is a given catalog integration currently enabled?
      instructions:
      - text: Fetch catalog integration {name}.
        slots:
          name: path.name
      - text: Show the catalog settings of this catalog integration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/catalog-integrations/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a catalog integration
      effect: destructive
      questions:
      - How do I remove a catalog integration I no longer need?
      - What happens to Iceberg tables when their catalog integration is dropped?
      instructions:
      - text: Delete catalog integration {name}.
        slots:
          name: path.name
      - text: Drop this catalog integration from the account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/catalog-integrations/{name}:set-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Set tags on a catalog integration
      effect: write
      questions:
      - How do I attach tags to a catalog integration?
      - Can I label a catalog integration with an environment tag?
      instructions:
      - text: Set tags on catalog integration {name}.
        slots:
          name: path.name
      - text: Tag the catalog integration I named with its environment.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/catalog-integrations/{name}:unset-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from a catalog integration
      effect: write
      questions:
      - How can I remove a tag from a catalog integration?
      - Can I clear tag assignments on a catalog integration?
      instructions:
      - text: Unset tags from catalog integration {name}.
        slots:
          name: path.name
      - text: Remove the environment tag from the catalog integration I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/catalog-integrations/{name}:get-tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Get tag assignments for a catalog integration
      effect: read
      questions:
      - Which tags are assigned to a catalog integration?
      - Does reading a catalog integration's tags need an active warehouse?
      instructions:
      - text: Show all tags assigned to catalog integration {name}.
        slots:
          name: path.name
      - text: List the tag assignments on the catalog integration I named.
      method: generated
      generated: '2026-10-01'