Snowflake · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snowflake External Volume API

6 actions 6 updates phrasing extends openapi/snowflake-external-volume-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 6

$.info
$.paths['/api/v2/external-volumes'].get
$.paths['/api/v2/external-volumes'].post
$.paths['/api/v2/external-volumes/{name}'].get
$.paths['/api/v2/external-volumes/{name}'].delete
$.paths['/api/v2/external-volumes/{name}:undrop'].post

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 External Volume API
  version: 1.0.0
extends: openapi/snowflake-external-volume-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/api/v2/external-volumes'].get
  update:
    x-apievangelist-phrasing:
      intent: List external volumes
      effect: read
      questions:
      - Which external volumes are configured for my Iceberg tables?
      - Can I see all the external storage volumes in my account?
      instructions:
      - text: List all external volumes in the account.
      - text: Show me every configured external volume.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/external-volumes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an external volume
      effect: write
      questions:
      - How do I point Snowflake at my own cloud storage for Iceberg data?
      - Can I create an external volume that allows writes?
      instructions:
      - text: Create external volume {name} with storage locations {storage_locations}.
        slots:
          name: requestBody.name
          storage_locations: requestBody.storage_locations
      - text: Create external volume {name} on {storage_locations} with allow writes set to {allow_writes}.
        slots:
          name: requestBody.name
          storage_locations: requestBody.storage_locations
          allow_writes: requestBody.allow_writes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/external-volumes/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an external volume
      effect: read
      questions:
      - What storage locations does a specific external volume use?
      - Does a given external volume allow writes?
      instructions:
      - text: Fetch external volume {name}.
        slots:
          name: path.name
      - text: Show the storage locations of this external volume.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/external-volumes/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an external volume
      effect: destructive
      questions:
      - How do I remove an external volume?
      - Can I delete an external volume by its name?
      instructions:
      - text: Delete external volume {name}.
        slots:
          name: path.name
      - text: Drop this external volume from the account.
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/v2/external-volumes/{name}:undrop'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a dropped external volume
      effect: write
      questions:
      - I dropped an external volume by mistake; can I bring it back?
      - Is undrop supported for external volumes?
      instructions:
      - text: Undrop external volume {name} that I deleted.
        slots:
          name: path.name
      - text: Restore this recently dropped external volume.
      method: generated
      generated: '2026-10-01'