Confluent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Kafka REST Consumer Groups API

3 actions 3 updates phrasing extends openapi/confluent-consumer-groups-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 3

$.info
$.paths['/kafka/v3/clusters/{cluster_id}/consumer-groups'].get
$.paths['/kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_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 Kafka REST Consumer Groups API
  version: 1.0.0
extends: openapi/confluent-consumer-groups-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}/consumer-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List consumer groups
      effect: read
      questions:
      - Which consumer groups are reading from my Kafka cluster?
      - Can I see all consumer groups on a cluster?
      instructions:
      - text: List 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 and coordinator does a particular consumer group have?
      - Can I look up one consumer group by its ID?
      instructions:
      - text: Show consumer group {consumer_group_id} on cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
          consumer_group_id: path.consumer_group_id
      - text: Get details 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'