# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snowflake Stream API
  version: 1.0.0
extends: openapi/snowflake-stream-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: 8
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streams'].get
  update:
    x-apievangelist-phrasing:
      intent: List streams in a schema
      effect: read
      questions:
      - Which change-data-capture streams exist in this schema?
      - Can I see whether any of my streams have gone stale?
      instructions:
      - text: List all streams in schema {schema} of database {database}.
        slots:
          database: path.database
          schema: path.schema
      - text: Show me the streams defined here.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streams'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a change-tracking stream
      effect: write
      questions:
      - How do I track inserts, updates and deletes on a table with a stream?
      - What source objects can a stream be created on?
      instructions:
      - text: Create stream {name} in {database}.{schema} on source {stream_source}.
        slots:
          name: requestBody.name
          stream_source: requestBody.stream_source
          database: path.database
          schema: path.schema
      - text: Create stream {name} tracking changes from {stream_source} with comment {comment}.
        slots:
          name: requestBody.name
          stream_source: requestBody.stream_source
          comment: requestBody.comment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streams/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe a stream
      effect: read
      questions:
      - What table does this stream track, and is it stale?
      - When will this stream become stale if I don't consume it?
      instructions:
      - text: Describe stream {stream} in {database}.{schema}.
        slots:
          stream: path.name
          database: path.database
          schema: path.schema
      - text: Fetch this stream's source, mode and staleness.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streams/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a stream
      effect: destructive
      questions:
      - How do I drop a stream I no longer consume?
      - Can a stream be deleted through the API?
      instructions:
      - text: Drop stream {stream} from {database}.{schema}.
        slots:
          stream: path.name
          database: path.database
          schema: path.schema
      - text: Delete the stream I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streams/{name}:clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a stream into a schema
      effect: write
      questions:
      - Can I copy a stream into another database and schema?
      - Does cloning a stream let me give the copy its own comment?
      instructions:
      - text: Clone stream {stream} from {database}.{schema} as {name} into {targetDatabase}.{targetSchema}.
        slots:
          stream: path.name
          database: path.database
          schema: path.schema
          name: requestBody.name
          targetDatabase: query.targetDatabase
          targetSchema: query.targetSchema
      - text: Clone this stream as {name} into {targetDatabase}.{targetSchema} with comment {comment}.
        slots:
          name: requestBody.name
          targetDatabase: query.targetDatabase
          targetSchema: query.targetSchema
          comment: requestBody.comment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streams/{name}:set-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Set tags on a stream
      effect: write
      questions:
      - How do I tag a stream?
      - Can I label a stream with a pipeline tag?
      instructions:
      - text: Set tags on stream {stream} in {database}.{schema}.
        slots:
          stream: path.name
          database: path.database
          schema: path.schema
      - text: Apply my tag assignments to the stream I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streams/{name}:unset-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from a stream
      effect: write
      questions:
      - Can I remove tags from a stream?
      - What's the way to clear a tag off a stream?
      instructions:
      - text: Unset the tags on stream {stream} in {database}.{schema}.
        slots:
          stream: path.name
          database: path.database
          schema: path.schema
      - text: Remove the tag assignments from the stream I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/streams/{name}:get-tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the tags assigned to a stream
      effect: read
      questions:
      - Which tags are assigned to this stream?
      - Does reading a stream's tags need an active warehouse?
      instructions:
      - text: Show every tag assigned to stream {stream} in {database}.{schema}.
        slots:
          stream: path.name
          database: path.database
          schema: path.schema
      - text: List the tag assignments on the stream I named.
      method: generated
      generated: '2026-10-01'