Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Consumer Group (v3) API

8 actions 8 updates phrasing extends openapi/confluent-the-data-streaming-platform-consumer-group-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 8

$.info
$.paths['/kafka/v3/clusters/{cluster_id}/consumer-groups'].get
$.paths['/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}'].get
$.paths['/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers'].get
$.paths['/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lag-summary'].get
$.paths['/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags'].get
$.paths['/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags/{topic_name}/partitions/{partition_id}'].get
$.paths['/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers/{consumer_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 Consumer Group (v3) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-consumer-group-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: 7
- target: $.paths['/kafka/v3/clusters/{cluster_id}/consumer-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List consumer groups on a cluster
      effect: read
      questions:
      - Which consumer groups are reading from my Kafka cluster?
      - Can I see every consumer group registered on a Confluent Cloud cluster?
      instructions:
      - text: List consumer groups on cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
      - text: Show all consumer groups for Kafka cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a consumer group
      effect: read
      questions:
      - What state is a particular consumer group in?
      - Who is the coordinator and which assignor does my consumer group use?
      instructions:
      - text: Get consumer group {consumer_group_id} on cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
          consumer_group_id: path.consumer_group_id
      - text: Show details for consumer group {consumer_group_id} in cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
          consumer_group_id: path.consumer_group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers'].get
  update:
    x-apievangelist-phrasing:
      intent: List consumers in a group
      effect: read
      questions:
      - Which consumers are members of a consumer group right now?
      - How many consumer instances are in my group?
      instructions:
      - text: List consumers in group {consumer_group_id} on cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
          consumer_group_id: path.consumer_group_id
      - text: Show the member consumers of {consumer_group_id} in cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
          consumer_group_id: path.consumer_group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lag-summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize a consumer group's lag
      effect: read
      questions:
      - How far behind is my consumer group overall?
      - What is the maximum and total lag for a consumer group?
      instructions:
      - text: Get the lag summary for consumer group {consumer_group_id} on cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
          consumer_group_id: path.consumer_group_id
      - text: Show max and total lag of group {consumer_group_id} in cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
          consumer_group_id: path.consumer_group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags'].get
  update:
    x-apievangelist-phrasing:
      intent: List per-partition lag for a group
      effect: read
      questions:
      - Which partitions is my consumer group lagging on?
      - Can I break a consumer group's lag down by consumer and partition?
      instructions:
      - text: List consumer lags for group {consumer_group_id} on cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
          consumer_group_id: path.consumer_group_id
      - text: Break down lag per partition for consumer group {consumer_group_id} in cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
          consumer_group_id: path.consumer_group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags/{topic_name}/partitions/{partition_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get lag on one partition
      effect: read
      questions:
      - How far behind is my consumer group on one specific topic partition?
      - What are the current and end offsets for a group on a single partition?
      instructions:
      - text: Get lag of group {consumer_group_id} on topic {topic_name} partition {partition_id} in cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
          consumer_group_id: path.consumer_group_id
          topic_name: path.topic_name
          partition_id: path.partition_id
      - text: Check partition {partition_id} of {topic_name} lag for consumer group {consumer_group_id} on cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
          consumer_group_id: path.consumer_group_id
          topic_name: path.topic_name
          partition_id: path.partition_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers/{consumer_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one consumer in a group
      effect: read
      questions:
      - What client ID and host is a specific consumer running on?
      - Can I look up one consumer instance within a consumer group?
      instructions:
      - text: Get consumer {consumer_id} in group {consumer_group_id} on cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
          consumer_group_id: path.consumer_group_id
          consumer_id: path.consumer_id
      - text: Show details of consumer {consumer_id} from group {consumer_group_id} in cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
          consumer_group_id: path.consumer_group_id
          consumer_id: path.consumer_id
      method: generated
      generated: '2026-09-26'