Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-connections-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 6

$.info

$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections'].get

$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections'].post

$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}'].get

$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}'].put

$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}'].delete

OpenAPI Overlay

# 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 Connections (sql/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-connections-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: 5
- target: $.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List Flink SQL connections
      effect: read
      questions:
      - Which Flink SQL connections are set up in my environment?
      - Can I filter Flink connections by connection type?
      instructions:
      - text: List Flink SQL connections in environment {environment} of organization {org}.
        slots:
          environment: path.environment_id
          org: path.organization_id
      - text: Show {type} connections in {environment}.
        slots:
          type: query.spec.connection_type
          environment: path.environment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Flink SQL connection
      effect: write
      questions:
      - How do I create a connection so Flink SQL can reach an external service?
      - What goes in the spec when creating a Flink connection?
      instructions:
      - text: Create a Flink connection named {name} in environment {environment} of organization {org}.
        slots:
          name: requestBody.name
          environment: path.environment_id
          org: path.organization_id
      - text: Add connection {name} with spec {spec}.
        slots:
          name: requestBody.name
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a Flink SQL connection
      effect: read
      questions:
      - What endpoint and type does one Flink connection use?
      - Can I read a Flink SQL connection by its name?
      instructions:
      - text: Get Flink connection {connection} in environment {environment} of organization {org}.
        slots:
          connection: path.connection_name
          environment: path.environment_id
          org: path.organization_id
      - text: Show details of connection {connection}.
        slots:
          connection: path.connection_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Flink SQL connection
      effect: write
      questions:
      - Can I change the endpoint or credentials of an existing Flink connection?
      - How do I edit a Flink SQL connection's spec?
      instructions:
      - text: Update Flink connection {connection} in {environment} of organization {org} with spec {spec}.
        slots:
          connection: path.connection_name
          environment: path.environment_id
          org: path.organization_id
          spec: requestBody.spec
      - text: Replace the settings of connection {connection}.
        slots:
          connection: path.connection_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/connections/{connection_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Flink SQL connection
      effect: destructive
      questions:
      - Can I remove a Flink SQL connection I no longer use?
      - Is deleting a Flink connection permanent?
      instructions:
      - text: Delete Flink connection {connection} in environment {environment} of organization {org}.
        slots:
          connection: path.connection_name
          environment: path.environment_id
          org: path.organization_id
      - text: Remove connection {connection}.
        slots:
          connection: path.connection_name
      method: generated
      generated: '2026-09-26'