Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Tools (sql/v1) API

5 actions 5 updates phrasing extends openapi/confluent-the-data-streaming-platform-tools-sql-v1-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Confluent | the Data Streaming Platform's API. It is a proposal applied on top of the contract, not a document Confluent | the Data Streaming Platform publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools'].get
$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools'].post
$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools/{tool_name}'].get
$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools/{tool_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 Confluent Cloud Tools (sql/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-tools-sql-v1-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools'].get
  update:
    x-apievangelist-phrasing:
      intent: List Flink SQL tools in a database
      effect: read
      questions:
      - Which tools are defined in a Flink SQL database?
      - Can I list the preview SQL tools in one database?
      instructions:
      - text: List tools in database {database_name}, environment {environment_id}, org {organization_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          database_name: path.database_name
      - text: Show every SQL tool defined in {database_name} of environment {environment_id}, org {organization_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          database_name: path.database_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Flink SQL tool
      effect: write
      questions:
      - How do I define a new tool in a Flink SQL database?
      - Can I create a tool with a custom spec in a database?
      instructions:
      - text: Create tool {name} in database {database_name}, environment {environment_id}, org {organization_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          database_name: path.database_name
          name: requestBody.name
      - text: Add a SQL tool with spec {spec} to {database_name} in environment {environment_id}, org {organization_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          database_name: path.database_name
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools/{tool_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Flink SQL tool
      effect: read
      questions:
      - What is the definition of a particular SQL tool?
      - Can I read one tool by name from a database?
      instructions:
      - text: Show tool {tool_name} in database {database_name}, environment {environment_id}, org {organization_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          database_name: path.database_name
          tool_name: path.tool_name
      - text: Get the spec of SQL tool {tool_name} in {database_name}, environment {environment_id}, org {organization_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          database_name: path.database_name
          tool_name: path.tool_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{database_name}/tools/{tool_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Flink SQL tool
      effect: destructive
      questions:
      - How do I remove a tool from a Flink SQL database?
      - Can I delete a SQL tool by name?
      instructions:
      - text: Delete tool {tool_name} from database {database_name}, environment {environment_id}, org {organization_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          database_name: path.database_name
          tool_name: path.tool_name
      - text: Remove SQL tool {tool_name} in {database_name} of environment {environment_id}, org {organization_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          database_name: path.database_name
          tool_name: path.tool_name
      method: generated
      generated: '2026-09-26'