# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snowflake Notebook API
  version: 1.0.0
extends: openapi/snowflake-notebook-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: 11
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/notebooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List notebooks in a schema
      effect: read
      questions:
      - Which notebooks exist in this schema?
      - Can I see every Snowflake notebook stored in a schema?
      instructions:
      - text: List all notebooks in schema {schema} of database {database}.
        slots:
          schema: path.schema
          database: path.database
      - text: Show me the notebooks stored here.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/notebooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a notebook
      effect: write
      questions:
      - How do I create a notebook from a file already sitting in a stage?
      - Can I choose the query warehouse or compute pool a new notebook uses?
      instructions:
      - text: Create a notebook named {name} in {database}.{schema}.
        slots:
          name: requestBody.name
          database: path.database
          schema: path.schema
      - text: Create notebook {name} from {fromLocation} with main file {main_file}.
        slots:
          name: requestBody.name
          fromLocation: requestBody.fromLocation
          main_file: requestBody.main_file
      - text: Create notebook {name} that runs queries on warehouse {query_warehouse}.
        slots:
          name: requestBody.name
          query_warehouse: requestBody.query_warehouse
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe a single notebook
      effect: read
      questions:
      - What warehouse, versions and main file does this notebook have?
      - Can I look up the details of one notebook?
      instructions:
      - text: Describe notebook {name} in {database}.{schema}.
        slots:
          name: path.name
          database: path.database
          schema: path.schema
      - text: Fetch this notebook's details and versions.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a notebook
      effect: destructive
      questions:
      - How do I drop a notebook I no longer need?
      - Can a notebook be deleted through the REST API?
      instructions:
      - text: Drop notebook {name} from {database}.{schema}.
        slots:
          name: path.name
          database: path.database
          schema: path.schema
      - text: Delete the notebook I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a notebook
      effect: write
      questions:
      - Can I run a notebook end to end without opening it?
      - Is there a way to execute a notebook from a script or pipeline?
      instructions:
      - text: Execute notebook {name} in {database}.{schema}.
        slots:
          name: path.name
          database: path.database
          schema: path.schema
      - text: Run the notebook I named from start to finish.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:rename'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename or move a notebook
      effect: write
      questions:
      - How do I rename a notebook?
      - Can I move a notebook to a different database or schema while renaming it?
      instructions:
      - text: Rename notebook {database}.{schema}.{name} to {targetName}.
        slots:
          database: path.database
          schema: path.schema
          name: path.name
          targetName: query.targetName
      - text: Move this notebook to {targetDatabase}.{targetSchema} as {targetName}.
        slots:
          targetDatabase: query.targetDatabase
          targetSchema: query.targetSchema
          targetName: query.targetName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:add-live-version'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a LIVE version to a notebook
      effect: write
      questions:
      - Can I create an editable LIVE version of a notebook from its last version?
      - What does adding a live version to a notebook do?
      instructions:
      - text: Add a LIVE version to notebook {database}.{schema}.{name}.
        slots:
          database: path.database
          schema: path.schema
          name: path.name
      - text: Add a LIVE version based on the last version ({fromLast}) with comment {comment}.
        slots:
          fromLast: query.fromLast
          comment: query.comment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:commit'].post
  update:
    x-apievangelist-phrasing:
      intent: Commit a notebook's LIVE version
      effect: write
      questions:
      - How do I commit my notebook changes to its connected Git repository?
      - Can I name the version and add a message when committing a notebook?
      instructions:
      - text: Commit the LIVE version of notebook {database}.{schema}.{name}.
        slots:
          database: path.database
          schema: path.schema
          name: path.name
      - text: Commit this notebook as version {version} with message {comment}.
        slots:
          version: query.version
          comment: query.comment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:set-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Set tags on a notebook
      effect: write
      questions:
      - How do I tag a notebook?
      - Can I label a notebook with a project tag?
      instructions:
      - text: Set tags on notebook {database}.{schema}.{name}.
        slots:
          database: path.database
          schema: path.schema
          name: path.name
      - text: Apply my tag assignments to the notebook I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:unset-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from a notebook
      effect: write
      questions:
      - Can I remove tags from a notebook?
      - What's the way to clear a tag off a notebook?
      instructions:
      - text: Unset the tags on notebook {database}.{schema}.{name}.
        slots:
          database: path.database
          schema: path.schema
          name: path.name
      - text: Remove the tag assignments from the notebook I named.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:get-tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the tags assigned to a notebook
      effect: read
      questions:
      - Which tags are assigned to this notebook?
      - Does reading a notebook's tags need an active warehouse?
      instructions:
      - text: Show every tag assigned to notebook {database}.{schema}.{name}.
        slots:
          database: path.database
          schema: path.schema
          name: path.name
      - text: List the tag assignments on the notebook I named.
      method: generated
      generated: '2026-10-01'