Snowflake · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snowflake Network Rule API

5 actions 5 updates phrasing extends openapi/snowflake-network-rule-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 5

$.info
$.paths['/api/v2/databases/{database}/schemas/{schema}/network-rules'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/network-rules'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/network-rules/{name}'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/network-rules/{name}'].delete

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 Network Rule API
  version: 1.0.0
extends: openapi/snowflake-network-rule-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: 4
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/network-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List network rules in a schema
      effect: read
      questions:
      - Which network rules are defined in this schema?
      - Can I see all the host and IP rules we've grouped for policies?
      instructions:
      - text: List all network rules in schema {schema} of database {database}.
        slots:
          database: path.database
          schema: path.schema
      - text: Show me the network rules defined here.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/network-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a network rule
      effect: write
      questions:
      - How do I group a set of IP addresses or hosts into a network rule?
      - Can a network rule be used for egress to external hosts rather than ingress?
      instructions:
      - text: Create network rule {name} of type {type} in {database}.{schema} covering {value_list}.
        slots:
          database: path.database
          schema: path.schema
          name: requestBody.name
          type: requestBody.type
          value_list: requestBody.value_list
      - text: Create {type} network rule {name} in {mode} mode for {value_list}.
        slots:
          type: requestBody.type
          name: requestBody.name
          mode: requestBody.mode
          value_list: requestBody.value_list
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/network-rules/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe a network rule
      effect: read
      questions:
      - What values, type and mode does this network rule contain?
      - Can I look up one network rule's settings?
      instructions:
      - text: Describe network rule {name} in {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          name: path.name
      - text: Fetch this network rule's value list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/network-rules/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a network rule
      effect: destructive
      questions:
      - How do I drop a network rule?
      - Can a network rule be removed through the API?
      instructions:
      - text: Drop network rule {name} from {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          name: path.name
      - text: Delete the network rule I named.
      method: generated
      generated: '2026-10-01'