Confluent · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-connections-sql-v1-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Confluent's API. It is a proposal applied on top of the contract, not a document Confluent 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

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 Connections (sql/v1) API
  version: 1.0.0
extends: openapi/confluent-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 defined in my environment?
      - Can I filter Flink connections by connection type?
      instructions:
      - text: List connections in organization {organization_id}, environment {environment_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
      - text: List {connection_type} connections in environment {environment_id}, org {organization_id}.
        slots:
          connection_type: query.spec.connection_type
          environment_id: path.environment_id
          organization_id: path.organization_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 endpoint?
      - Can I store credentials for an external model endpoint as a Flink connection?
      instructions:
      - text: Create connection {name} in environment {environment_id}, org {organization_id}.
        slots:
          name: requestBody.name
          environment_id: path.environment_id
          organization_id: path.organization_id
      - text: Create Flink connection {name} with spec {spec} in {organization_id}/{environment_id}.
        slots:
          name: requestBody.name
          spec: requestBody.spec
          organization_id: path.organization_id
          environment_id: path.environment_id
      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: Get one Flink SQL connection
      effect: read
      questions:
      - What endpoint and type does a specific Flink connection use?
      - How do I read a Flink SQL connection by name?
      instructions:
      - text: Get connection {connection_name} in environment {environment_id}, org {organization_id}.
        slots:
          connection_name: path.connection_name
          environment_id: path.environment_id
          organization_id: path.organization_id
      - text: Show details of Flink connection {connection_name} in {organization_id}/{environment_id}.
        slots:
          connection_name: path.connection_name
          organization_id: path.organization_id
          environment_id: path.environment_id
      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 rotate the secret on an existing Flink SQL connection?
      - Is it possible to change a connection's endpoint without recreating it?
      instructions:
      - text: Update connection {connection_name} in {organization_id}/{environment_id} with spec {spec}.
        slots:
          connection_name: path.connection_name
          organization_id: path.organization_id
          environment_id: path.environment_id
          spec: requestBody.spec
      - text: Replace the spec of Flink connection {connection_name}, environment {environment_id}, org {organization_id}.
        slots:
          connection_name: path.connection_name
          environment_id: path.environment_id
          organization_id: path.organization_id
      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:
      - How do I delete a Flink SQL connection I no longer use?
      - Will removing a connection break statements that reference it?
      instructions:
      - text: Delete connection {connection_name} from environment {environment_id}, org {organization_id}.
        slots:
          connection_name: path.connection_name
          environment_id: path.environment_id
          organization_id: path.organization_id
      - text: Remove Flink connection {connection_name} in {organization_id}/{environment_id}.
        slots:
          connection_name: path.connection_name
          organization_id: path.organization_id
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'