Confluent · OpenAPI Overlay 1.0.0

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

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

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 Share Group (v3) API
  version: 1.0.0
extends: openapi/confluent-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 cluster
      effect: read
      questions:
      - Which share groups exist on my Kafka cluster?
      - Can I see all queue-style share groups for one cluster?
      instructions:
      - text: List share groups on cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
      - text: Show every share 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}/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?
      - How do I look up a single share group by its group ID?
      instructions:
      - text: Get share group {group_id} on cluster {cluster_id}.
        slots:
          group_id: path.group_id
          cluster_id: path.cluster_id
      - text: Show details of share group {group_id} in cluster {cluster_id}.
        slots:
          group_id: path.group_id
          cluster_id: path.cluster_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?
      - How do I remove a stale share group from a cluster?
      instructions:
      - text: Delete share group {group_id} from cluster {cluster_id}.
        slots:
          group_id: path.group_id
          cluster_id: path.cluster_id
      - text: Remove share group {group_id} on {cluster_id}.
        slots:
          group_id: path.group_id
          cluster_id: 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?
      - Can I count the consumers reading from one share group?
      instructions:
      - text: List consumers in share group {group_id} on cluster {cluster_id}.
        slots:
          group_id: path.group_id
          cluster_id: path.cluster_id
      - text: Show all members consuming in share group {group_id}, cluster {cluster_id}.
        slots:
          group_id: path.group_id
          cluster_id: path.cluster_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, like its client ID?
      - How do I look up a single share group consumer by consumer ID?
      instructions:
      - text: Get consumer {consumer_id} in share group {group_id} on cluster {cluster_id}.
        slots:
          consumer_id: path.consumer_id
          group_id: path.group_id
          cluster_id: path.cluster_id
      - text: Show details of share consumer {consumer_id}, group {group_id}, cluster {cluster_id}.
        slots:
          consumer_id: path.consumer_id
          group_id: path.group_id
          cluster_id: path.cluster_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 consumer's partition assignments
      effect: read
      questions:
      - Which topic partitions is a share group consumer assigned to?
      - Can I see the assignments of one consumer in a share group?
      instructions:
      - text: List assignments of consumer {consumer_id} in share group {group_id} on cluster {cluster_id}.
        slots:
          consumer_id: path.consumer_id
          group_id: path.group_id
          cluster_id: path.cluster_id
      - text: Show which partitions share consumer {consumer_id} of group {group_id} holds on {cluster_id}.
        slots:
          consumer_id: path.consumer_id
          group_id: path.group_id
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'