Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

5 actions 5 updates phrasing extends openapi/confluent-the-data-streaming-platform-kafka-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/kafka-clusters'].get
$.paths['/usm/v1/kafka-clusters'].post
$.paths['/usm/v1/kafka-clusters/{id}'].get
$.paths['/usm/v1/kafka-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 Kafka Clusters (usm/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-kafka-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/kafka-clusters'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered Confluent Platform clusters
      effect: read
      questions:
      - Which self-managed Confluent Platform clusters are registered with Unified Stream Manager?
      - Can I list registered on-prem Kafka clusters in an environment?
      instructions:
      - text: List registered Kafka clusters in environment {environment}.
        slots:
          environment: query.environment
      - text: Show Confluent Platform clusters registered in {environment}.
        slots:
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usm/v1/kafka-clusters'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a Confluent Platform cluster
      effect: write
      questions:
      - How do I register my self-managed Confluent Platform Kafka cluster with the cloud?
      - Can I choose the cloud and region where my cluster's metadata is stored?
      instructions:
      - text: Register Confluent Platform cluster {confluent_platform_kafka_cluster_id} as {display_name} in environment {environment}.
        slots:
          confluent_platform_kafka_cluster_id: requestBody.confluent_platform_kafka_cluster_id
          display_name: requestBody.display_name
          environment: requestBody.environment
      - text: Store metadata for cluster {confluent_platform_kafka_cluster_id} in {cloud} region {region}.
        slots:
          confluent_platform_kafka_cluster_id: requestBody.confluent_platform_kafka_cluster_id
          cloud: requestBody.cloud
          region: requestBody.region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usm/v1/kafka-clusters/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a registered Confluent Platform cluster
      effect: read
      questions:
      - What cloud and region hold the metadata for my registered cluster?
      - Can I read a registered Confluent Platform cluster by ID?
      instructions:
      - text: Get registered Kafka cluster {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Show registration details of Confluent Platform cluster {id} in {environment}.
        slots:
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usm/v1/kafka-clusters/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unregister a Confluent Platform cluster
      effect: destructive
      questions:
      - How do I unregister a self-managed cluster from Unified Stream Manager?
      - Can I remove a registered Confluent Platform cluster?
      instructions:
      - text: Delete registered Kafka cluster {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Unregister Confluent Platform cluster {id} from {environment}.
        slots:
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'