Confluent · 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-connect-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/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-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 Confluent Platform Connect clusters are registered for unified stream manager?
      - Can I page through the Connect clusters in one environment?
      instructions:
      - text: List Connect clusters in environment {environment}.
        slots:
          environment: query.environment
      - text: Show registered Connect clusters for env {environment}, {page_size} per page.
        slots:
          environment: query.environment
          page_size: query.page_size
      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 self-managed Connect cluster with Confluent Cloud?
      - What IDs does registering a Connect cluster require?
      instructions:
      - text: Register Connect cluster {confluent_platform_connect_cluster_id} for Kafka cluster {kafka_cluster_id} in environment {environment}.
        slots:
          confluent_platform_connect_cluster_id: requestBody.confluent_platform_connect_cluster_id
          kafka_cluster_id: requestBody.kafka_cluster_id
          environment: requestBody.environment
      - text: Create a Connect cluster registration on {cloud} region {region} in env {environment}.
        slots:
          cloud: requestBody.cloud
          region: requestBody.region
          environment: requestBody.environment
      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 are the details of one registered Connect cluster?
      - Is a particular Connect cluster registered?
      instructions:
      - text: Get Connect cluster {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Show registration details of Connect cluster {id} in env {environment}.
        slots:
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usm/v1/connect-clusters/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unregister a Connect cluster
      effect: destructive
      questions:
      - How do I unregister a Connect cluster?
      - Can I delete a Connect cluster registration from an environment?
      instructions:
      - text: Delete Connect cluster {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Unregister Connect cluster {id} from env {environment}.
        slots:
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'