# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snowflake Pipe API
  version: 1.0.0
extends: openapi/snowflake-pipe-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}/pipes'].get
  update:
    x-apievangelist-phrasing:
      intent: List Snowpipe pipes in a schema
      effect: read
      questions:
      - Which Snowpipe pipes are defined in this schema?
      - Can I see every ingestion pipe in a database schema?
      instructions:
      - text: List the pipes in schema {schema} of database {database}.
        slots:
          database: path.database
          schema: path.schema
      - text: Show me all Snowpipe pipes in the schema I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/pipes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Snowpipe pipe
      effect: write
      questions:
      - How do I set up continuous loading from a stage with a pipe?
      - Can a new pipe auto-ingest files when they land in cloud storage?
      instructions:
      - text: Create pipe {name} in {database}.{schema} that runs {copy_statement}.
        slots:
          name: requestBody.name
          copy_statement: requestBody.copy_statement
          database: path.database
          schema: path.schema
      - text: Create auto-ingest pipe {name} with {copy_statement} and auto_ingest set to {auto_ingest}.
        slots:
          name: requestBody.name
          copy_statement: requestBody.copy_statement
          auto_ingest: requestBody.auto_ingest
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/pipes/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pipe's definition
      effect: read
      questions:
      - What COPY statement does a particular pipe run?
      - Is a given pipe set to auto-ingest?
      instructions:
      - text: Fetch pipe {pipe} from {database}.{schema}.
        slots:
          pipe: path.name
          database: path.database
          schema: path.schema
      - text: Show the COPY statement and settings of this pipe.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/pipes/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pipe
      effect: destructive
      questions:
      - How do I remove a Snowpipe pipe?
      - What happens to queued files when I drop a pipe?
      instructions:
      - text: Delete pipe {pipe} from {database}.{schema}.
        slots:
          pipe: path.name
          database: path.database
          schema: path.schema
      - text: Drop this pipe from the schema.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/pipes/{name}:refresh'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh a pipe to load staged files
      effect: write
      questions:
      - Can I make a pipe pick up files already sitting in the stage?
      - Is it possible to refresh a pipe only for files under a prefix or modified after a date?
      instructions:
      - text: Refresh pipe {pipe} in {database}.{schema} for files under prefix {prefix}.
        slots:
          pipe: path.name
          database: path.database
          schema: path.schema
          prefix: query.prefix
      - text: Refresh the pipe to queue files modified after {modified_after}.
        slots:
          modified_after: query.modified_after
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/pipes/{name}:set-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Set tags on a pipe
      effect: write
      questions:
      - How do I attach tags to a pipe?
      - Can I label a pipe with a source system tag?
      instructions:
      - text: Set tags on pipe {pipe} in {database}.{schema}.
        slots:
          pipe: path.name
          database: path.database
          schema: path.schema
      - text: Tag the pipe I named with its source system.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/pipes/{name}:unset-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from a pipe
      effect: write
      questions:
      - How can I remove a tag from a pipe?
      - Can I clear tag assignments on a pipe?
      instructions:
      - text: Unset tags from pipe {pipe} in {database}.{schema}.
        slots:
          pipe: path.name
          database: path.database
          schema: path.schema
      - text: Remove the source system tag from the pipe I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/pipes/{name}:get-tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Get tag assignments for a pipe
      effect: read
      questions:
      - Which tags are assigned to a pipe?
      - Does reading a pipe's tags need an active warehouse?
      instructions:
      - text: Show all tags assigned to pipe {pipe} in {database}.{schema}.
        slots:
          pipe: path.name
          database: path.database
          schema: path.schema
      - text: List the tag assignments on the pipe I named.
      method: generated
      generated: '2026-10-01'