Confluent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Kafka REST Topics API

5 actions 5 updates phrasing extends openapi/confluent-topics-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['/kafka/v3/clusters/{cluster_id}/topics'].get
$.paths['/kafka/v3/clusters/{cluster_id}/topics'].post
$.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}'].get
$.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}'].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 REST Topics API
  version: 1.0.0
extends: openapi/confluent-topics-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['/kafka/v3/clusters/{cluster_id}/topics'].get
  update:
    x-apievangelist-phrasing:
      intent: List topics in a cluster
      effect: read
      questions:
      - Which topics are in my Kafka cluster?
      - Can I see all topic names for a cluster?
      instructions:
      - text: List topics in cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
      - text: Show every topic on Kafka cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/topics'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a topic
      effect: write
      questions:
      - How do I create a topic with a chosen replication factor?
      - Can I set topic configs when creating it?
      instructions:
      - text: Create topic {topic_name} in cluster {cluster_id}.
        slots:
          topic_name: requestBody.topic_name
          cluster_id: path.cluster_id
      - text: Create topic {topic_name} on cluster {cluster_id} with replication factor {replication_factor}.
        slots:
          topic_name: requestBody.topic_name
          cluster_id: path.cluster_id
          replication_factor: requestBody.replication_factor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get topic metadata
      effect: read
      questions:
      - What metadata does a topic have, like partitions and replication?
      - Can I check how a single topic is configured?
      instructions:
      - text: Get metadata for topic {topic_name} in cluster {cluster_id}.
        slots:
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      - text: Describe topic {topic_name} on cluster {cluster_id}.
        slots:
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a topic
      effect: destructive
      questions:
      - How do I delete a topic from my cluster?
      - Can I remove a topic I created for testing?
      instructions:
      - text: Delete topic {topic_name} in cluster {cluster_id}.
        slots:
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      - text: Remove topic {topic_name} from cluster {cluster_id}.
        slots:
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'