Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/confluent-the-data-streaming-platform-partition-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 3

$.info
$.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/partitions'].get
$.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id}'].get

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 Partition (v3) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-partition-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: 2
- target: $.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/partitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a topic's partitions
      effect: read
      questions:
      - How many partitions does my Kafka topic have?
      - Can I see the partitions and leaders of a topic?
      instructions:
      - text: List partitions of topic {topic_name} on cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
          topic_name: path.topic_name
      - text: Show all partitions for {topic_name} in cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
          topic_name: path.topic_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a topic partition
      effect: read
      questions:
      - Which broker leads a specific partition of my topic?
      - Can I read details of a single partition by its id?
      instructions:
      - text: Show partition {partition_id} of topic {topic_name} on cluster {cluster_id}.
        slots:
          partition_id: path.partition_id
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      - text: Get the leader of partition {partition_id} in {topic_name}, cluster {cluster_id}.
        slots:
          partition_id: path.partition_id
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'