Confluent · 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-kafka-clusters-usm-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 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-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 Kafka clusters
      effect: read
      questions:
      - Which self-managed Confluent Platform clusters are registered in an environment?
      - How do I see the on-prem Kafka clusters connected to Unified Stream Manager?
      instructions:
      - text: List registered Confluent Platform Kafka clusters in environment {environment}.
        slots:
          environment: query.environment
      - text: Show the self-managed Kafka 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 Kafka cluster
      effect: write
      questions:
      - Can I register a self-managed Kafka cluster with Confluent Cloud?
      - What cloud and region store metadata for a registered Confluent Platform cluster?
      instructions:
      - text: Register Confluent Platform cluster {confluent_platform_kafka_cluster_id} as {display_name} in {environment}.
        slots:
          confluent_platform_kafka_cluster_id: requestBody.confluent_platform_kafka_cluster_id
          display_name: requestBody.display_name
          environment: requestBody.environment
      - text: Register my self-managed Kafka cluster with metadata stored in {cloud} region {region}.
        slots:
          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 details are stored for a self-managed cluster I registered?
      - Can I read one registered Confluent Platform Kafka cluster?
      instructions:
      - text: Get registered Kafka cluster {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Show the registration 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 Kafka cluster?
      - Can I remove a Confluent Platform cluster from Unified Stream Manager?
      instructions:
      - text: Unregister Kafka cluster {id} from environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Delete the registered Confluent Platform cluster {id} in {environment}.
        slots:
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'