Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Connect Clusters (usm/v1) API

5 actions 5 updates phrasing extends openapi/confluent-the-data-streaming-platform-connect-clusters-usm-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['/usm/v1/connect-clusters'].get
$.paths['/usm/v1/connect-clusters'].post
$.paths['/usm/v1/connect-clusters/{id}'].get
$.paths['/usm/v1/connect-clusters/{id}'].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 Connect Clusters (usm/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-connect-clusters-usm-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['/usm/v1/connect-clusters'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered Connect clusters
      effect: read
      questions:
      - Which self-managed Connect clusters are registered with Unified Stream Manager?
      - Can I page through the Connect clusters in one environment?
      instructions:
      - text: List Connect clusters registered in environment {environment}.
        slots:
          environment: query.environment
      - text: Show {page_size} Connect clusters from environment {environment}.
        slots:
          page_size: query.page_size
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usm/v1/connect-clusters'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a Connect cluster
      effect: write
      questions:
      - How do I register a Confluent Platform Connect cluster with Confluent Cloud?
      - What IDs do I need to link an on-prem Connect cluster to my environment?
      instructions:
      - text: Register Confluent Platform Connect cluster {confluent_platform_connect_cluster_id} in environment {environment}.
        slots:
          confluent_platform_connect_cluster_id: requestBody.confluent_platform_connect_cluster_id
          environment: requestBody.environment
      - text: Register Connect cluster {confluent_platform_connect_cluster_id} backed by Kafka cluster {kafka_cluster_id} in {cloud} region {region}.
        slots:
          confluent_platform_connect_cluster_id: requestBody.confluent_platform_connect_cluster_id
          kafka_cluster_id: requestBody.kafka_cluster_id
          cloud: requestBody.cloud
          region: requestBody.region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usm/v1/connect-clusters/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a registered Connect cluster
      effect: read
      questions:
      - What Kafka cluster and region is a registered Connect cluster tied to?
      - Can I look up one registered Connect cluster by ID?
      instructions:
      - text: Show Connect cluster {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Read the registration details of Connect cluster {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usm/v1/connect-clusters/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Deregister a Connect cluster
      effect: destructive
      questions:
      - How do I deregister a Connect cluster from Unified Stream Manager?
      - Can I delete a registered Connect cluster from an environment?
      instructions:
      - text: Delete Connect cluster {id} from environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Deregister Connect cluster {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'