Confluent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Kafka REST Clusters API

3 actions 3 updates phrasing extends openapi/confluent-clusters-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 3

$.info

$.paths['/kafka/v3/clusters'].get

$.paths['/kafka/v3/clusters/{cluster_id}'].get

OpenAPI Overlay

# 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 REST Clusters API
  version: 1.0.0
extends: openapi/confluent-clusters-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: 2
- target: $.paths['/kafka/v3/clusters'].get
  update:
    x-apievangelist-phrasing:
      intent: List Kafka clusters
      effect: read
      questions:
      - Which Kafka clusters can I reach through this REST endpoint?
      - Can I get the IDs of all my Kafka clusters?
      instructions:
      - text: List my Kafka clusters.
      - text: Show all Kafka clusters with their IDs.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Kafka cluster
      effect: read
      questions:
      - What are the details of one Kafka cluster?
      - Can I look up a Kafka cluster by its ID?
      instructions:
      - text: Get Kafka cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
      - text: Show details for cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'