Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

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

$.info

$.paths['/kafka/v3/clusters/{cluster_id}/share-groups'].get

$.paths['/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}'].get

$.paths['/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}'].delete

$.paths['/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers'].get

$.paths['/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id}'].get

$.paths['/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id}/assignments'].get

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 Share Group (v3) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-share-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: 6
- target: $.paths['/kafka/v3/clusters/{cluster_id}/share-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List share groups on a Kafka cluster
      effect: read
      questions:
      - Which share groups (queues for Kafka) exist on my cluster?
      - Can I see all share groups on a Confluent Kafka cluster?
      instructions:
      - text: List the share groups on cluster {cluster}.
        slots:
          cluster: path.cluster_id
      - text: Show every share group in {cluster}.
        slots:
          cluster: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one share group
      effect: read
      questions:
      - What state is a particular share group in?
      - Can I look up a share group by its group ID?
      instructions:
      - text: Get share group {group} on cluster {cluster}.
        slots:
          group: path.group_id
          cluster: path.cluster_id
      - text: Show details of share group {group}.
        slots:
          group: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a share group
      effect: destructive
      questions:
      - Can I delete a share group I no longer need?
      - Is removing a share group reversible?
      instructions:
      - text: Delete share group {group} from cluster {cluster}.
        slots:
          group: path.group_id
          cluster: path.cluster_id
      - text: Remove the {group} share group in {cluster}.
        slots:
          group: path.group_id
          cluster: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers'].get
  update:
    x-apievangelist-phrasing:
      intent: List consumers in a share group
      effect: read
      questions:
      - Which consumers are currently part of a share group?
      - How many consumers are sharing a group's workload?
      instructions:
      - text: List the consumers of share group {group} on cluster {cluster}.
        slots:
          group: path.group_id
          cluster: path.cluster_id
      - text: Show all consumers attached to share group {group}.
        slots:
          group: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one consumer in a share group
      effect: read
      questions:
      - What do I know about one consumer in a share group?
      - Where do I find one share consumer's details from its consumer ID?
      instructions:
      - text: Get consumer {consumer} of share group {group} on cluster {cluster}.
        slots:
          consumer: path.consumer_id
          group: path.group_id
          cluster: path.cluster_id
      - text: Show share group consumer {consumer} in {group}.
        slots:
          consumer: path.consumer_id
          group: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id}/assignments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a share group consumer's assignments
      effect: read
      questions:
      - Which topic partitions is a share group consumer assigned?
      - Can I see what one consumer in a share group is reading from?
      instructions:
      - text: List the assignments of consumer {consumer} in share group {group} on cluster {cluster}.
        slots:
          consumer: path.consumer_id
          group: path.group_id
          cluster: path.cluster_id
      - text: Show which partitions consumer {consumer} of share group {group} is assigned.
        slots:
          consumer: path.consumer_id
          group: path.group_id
      method: generated
      generated: '2026-09-26'