Confluent · OpenAPI Overlay 1.0.0

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

8 actions 8 updates phrasing extends openapi/confluent-consumer-group-v3-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 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-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 in a cluster
      effect: read
      questions:
      - Which consumer groups are reading from my Kafka cluster?
      - How do I list all consumer groups on a cluster?
      instructions:
      - text: List the consumer groups on cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
      - text: Show every consumer group in 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?
      - Can I look up one consumer group's details by its ID?
      instructions:
      - text: Get consumer group {consumer_group_id} on cluster {cluster_id}.
        slots:
          consumer_group_id: path.consumer_group_id
          cluster_id: path.cluster_id
      - text: Show details of group {consumer_group_id} in {cluster_id}.
        slots:
          consumer_group_id: path.consumer_group_id
          cluster_id: path.cluster_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 consumer instances are members of a consumer group?
      - How many consumers are currently in one of my groups?
      instructions:
      - text: List the consumers in group {consumer_group_id} on cluster {cluster_id}.
        slots:
          consumer_group_id: path.consumer_group_id
          cluster_id: path.cluster_id
      - text: Show members of consumer group {consumer_group_id} in {cluster_id}.
        slots:
          consumer_group_id: path.consumer_group_id
          cluster_id: path.cluster_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: Get a consumer group's lag summary
      effect: read
      questions:
      - What is the maximum and total lag for a consumer group?
      - Is consumer group lag summary only available on dedicated clusters?
      instructions:
      - text: Get the lag summary for group {consumer_group_id} on cluster {cluster_id}.
        slots:
          consumer_group_id: path.consumer_group_id
          cluster_id: path.cluster_id
      - text: Show max and total lag of consumer group {consumer_group_id} in {cluster_id}.
        slots:
          consumer_group_id: path.consumer_group_id
          cluster_id: path.cluster_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 lags for a group
      effect: read
      questions:
      - Which partitions are my group's consumers falling behind on?
      - Can I see lag broken down for every consumer in a group?
      instructions:
      - text: List consumer lags for group {consumer_group_id} on cluster {cluster_id}.
        slots:
          consumer_group_id: path.consumer_group_id
          cluster_id: path.cluster_id
      - text: Break down lag by partition for group {consumer_group_id} in {cluster_id}.
        slots:
          consumer_group_id: path.consumer_group_id
          cluster_id: path.cluster_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 consumer lag on one partition
      effect: read
      questions:
      - How far behind is my consumer group on one specific topic partition?
      - What's the lag for a single partition of a topic?
      instructions:
      - text: Get lag for group {consumer_group_id} on {topic_name} partition {partition_id} in cluster {cluster_id}.
        slots:
          consumer_group_id: path.consumer_group_id
          topic_name: path.topic_name
          partition_id: path.partition_id
          cluster_id: path.cluster_id
      - text: How far behind is {consumer_group_id} on partition {partition_id} of {topic_name} in {cluster_id}.
        slots:
          consumer_group_id: path.consumer_group_id
          topic_name: path.topic_name
          partition_id: path.partition_id
          cluster_id: path.cluster_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 and assignments does a specific consumer in a group have?
      - Can I look up a single consumer instance by its ID?
      instructions:
      - text: Get consumer {consumer_id} in group {consumer_group_id} on cluster {cluster_id}.
        slots:
          consumer_id: path.consumer_id
          consumer_group_id: path.consumer_group_id
          cluster_id: path.cluster_id
      - text: Show details for consumer {consumer_id} of {consumer_group_id} in {cluster_id}.
        slots:
          consumer_id: path.consumer_id
          consumer_group_id: path.consumer_group_id
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'