Snowflake · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snowflake Account API

5 actions 5 updates phrasing extends openapi/snowflake-account-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/accounts'].get
$.paths['/api/v2/accounts'].post
$.paths['/api/v2/accounts/{name}'].delete
$.paths['/api/v2/accounts/{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 Account API
  version: 1.0.0
extends: openapi/snowflake-account-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/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List accounts in the organization
      effect: read
      questions:
      - Which Snowflake accounts exist in my organization?
      - Can I include dropped accounts that are still in their grace period?
      instructions:
      - text: List the accounts in our organization.
      - text: List accounts with history set to {history} so dropped ones appear.
        slots:
          history: query.history
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account in the organization
      effect: write
      questions:
      - How do I create a new account in my organization with an admin user?
      - Can I choose the edition and region for a new account?
      instructions:
      - text: Create account {name} on edition {edition} with admin {admin_name} at {email}.
        slots:
          name: requestBody.name
          edition: requestBody.edition
          admin_name: requestBody.admin_name
          email: requestBody.email
      - text: Create {edition} account {name} in region {region}, admin {admin_name}, email {email}.
        slots:
          edition: requestBody.edition
          name: requestBody.name
          region: requestBody.region
          admin_name: requestBody.admin_name
          email: requestBody.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Drop an account
      effect: destructive
      questions:
      - How do I drop an account from my organization?
      - How long a grace period can I give a dropped account before it's permanently deleted?
      instructions:
      - text: Drop account {name} with a {days}-day grace period.
        slots:
          name: path.name
          days: query.gracePeriodInDays
      - text: Delete the account, keeping it recoverable for {days} days.
        slots:
          days: query.gracePeriodInDays
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/accounts/{name}:undrop'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a dropped account
      effect: write
      questions:
      - Can I recover an account I dropped while it's still in its grace period?
      - Is there a way to undo dropping an organization account?
      instructions:
      - text: Restore dropped account {name}.
        slots:
          name: path.name
      - text: Undrop the account before its grace period runs out.
      method: generated
      generated: '2026-10-01'