Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Topic (v3) API

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-topic-v3-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 6

$.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

$.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}'].patch

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 Topic (v3) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-topic-v3-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: 5
- target: $.paths['/kafka/v3/clusters/{cluster_id}/topics'].get
  update:
    x-apievangelist-phrasing:
      intent: List Kafka topics in a cluster
      effect: read
      questions:
      - What topics exist in my Kafka cluster?
      - Can I get every topic name in a Confluent Cloud cluster?
      instructions:
      - text: List the topics in cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
      - text: Show all Kafka topics on {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 Kafka topic
      effect: write
      questions:
      - How do I create a Kafka topic with a set number of partitions?
      - Can I dry-run a topic creation to check it would succeed?
      instructions:
      - text: Create topic {topic_name} in cluster {cluster_id} with {partitions_count} partitions.
        slots:
          topic_name: requestBody.topic_name
          cluster_id: path.cluster_id
          partitions_count: requestBody.partitions_count
      - text: Validate creating topic {topic_name} on {cluster_id} without creating it.
        slots:
          topic_name: requestBody.topic_name
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Kafka topic
      effect: read
      questions:
      - How many partitions and what replication factor does a topic have?
      - Can I see which operations I am authorized to perform on a topic?
      instructions:
      - text: Show topic {topic_name} in cluster {cluster_id}.
        slots:
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      - text: Describe topic {topic_name} including my authorized operations.
        slots:
          topic_name: path.topic_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Kafka topic
      effect: destructive
      questions:
      - What happens to the data when I delete a Kafka topic?
      - Can I delete a topic from my cluster through the REST API?
      instructions:
      - text: Delete topic {topic_name} from cluster {cluster_id}.
        slots:
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      - text: Drop Kafka topic {topic_name}.
        slots:
          topic_name: path.topic_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Increase a topic's partition count
      effect: write
      questions:
      - How do I add more partitions to an existing topic?
      - Can I reduce a topic's partition count, or only increase it?
      instructions:
      - text: Increase topic {topic_name} in cluster {cluster_id} to {partitions_count} partitions.
        slots:
          topic_name: path.topic_name
          cluster_id: path.cluster_id
          partitions_count: requestBody.partitions_count
      - text: Raise the partition count of {topic_name} to {partitions_count}.
        slots:
          topic_name: path.topic_name
          partitions_count: requestBody.partitions_count
      method: generated
      generated: '2026-09-26'