Snowflake · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snowflake Secret API

5 actions 5 updates phrasing extends openapi/snowflake-secret-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}/secrets'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/secrets'].post
$.paths['/api/v2/databases/{database}/schemas/{schema}/secrets/{name}'].get
$.paths['/api/v2/databases/{database}/schemas/{schema}/secrets/{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 Secret API
  version: 1.0.0
extends: openapi/snowflake-secret-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}/secrets'].get
  update:
    x-apievangelist-phrasing:
      intent: List secrets in a schema
      effect: read
      questions:
      - Which secret objects are stored in this schema?
      - Can I list every secret under a database and schema?
      instructions:
      - text: List the secrets in schema {schema} of database {database}.
        slots:
          database: path.database
          schema: path.schema
      - text: Show me all secret objects defined here.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/secrets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a secret
      effect: write
      questions:
      - How do I store a credential as a secret object for integrations to use?
      - What secret types can I create?
      instructions:
      - text: Create a {type} secret named {name} in {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          type: requestBody.type
          name: requestBody.name
      - text: Create secret {name} of type {type} with the comment {comment}.
        slots:
          name: requestBody.name
          type: requestBody.type
          comment: requestBody.comment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/secrets/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the details of a secret
      effect: read
      questions:
      - What type and owner does a particular secret have?
      - Where can I see one secret object's metadata?
      instructions:
      - text: Show me the details of secret {name} in {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          name: path.name
      - text: Fetch the secret's type and owner.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/secrets/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a secret
      effect: destructive
      questions:
      - How do I delete a secret that's no longer used?
      - Can a secret object be dropped through the API?
      instructions:
      - text: Delete secret {name} from {database}.{schema}.
        slots:
          database: path.database
          schema: path.schema
          name: path.name
      - text: Drop the secret object permanently.
      method: generated
      generated: '2026-10-01'