Confluent · OpenAPI Overlay 1.0.0

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

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

$.info

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

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

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

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

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

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

$.paths['/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments'].get

$.paths['/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments'].get

$.paths['/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments/{assignments_type}'].get

$.paths['/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments/{assignments_type}'].get

$.paths['/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments/{assignments_type}/subtopologies/{subtopology_id}'].get

$.paths['/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments/{assignments_type}/subtopologies/{subtopology_id}'].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 Streams Group (v3) API
  version: 1.0.0
extends: openapi/confluent-streams-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: 12
- target: $.paths['/kafka/v3/clusters/{cluster_id}/streams-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List Kafka Streams groups on a cluster
      effect: read
      questions:
      - Which Kafka Streams applications are registered as streams groups on my Confluent cluster?
      - Can I see every streams group running against one Kafka cluster?
      instructions:
      - text: List the streams groups on Kafka cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
      - text: Show me all Kafka Streams groups in cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one streams group
      effect: read
      questions:
      - What state is a particular Kafka Streams group in right now?
      - How do I look up a single streams group by its group ID?
      instructions:
      - text: Get streams group {group_id} on cluster {cluster_id}.
        slots:
          group_id: path.group_id
          cluster_id: path.cluster_id
      - text: Show the details of Kafka Streams 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}/streams-groups/{group_id}/subtopologies'].get
  update:
    x-apievangelist-phrasing:
      intent: List subtopologies of a streams group
      effect: read
      questions:
      - What subtopologies make up my Kafka Streams group's topology?
      - Can I list all the subtopologies a streams group is processing?
      instructions:
      - text: List the subtopologies of streams group {group_id} on cluster {cluster_id}.
        slots:
          group_id: path.group_id
          cluster_id: path.cluster_id
      - text: Show every subtopology in Kafka Streams 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}/streams-groups/{group_id}/subtopologies/{subtopology_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one subtopology of a streams group
      effect: read
      questions:
      - Which source topics feed a specific subtopology in my streams group?
      - How do I inspect one subtopology of a Kafka Streams group by its ID?
      instructions:
      - text: Get subtopology {subtopology_id} of streams group {group_id} on cluster {cluster_id}.
        slots:
          subtopology_id: path.subtopology_id
          group_id: path.group_id
          cluster_id: path.cluster_id
      - text: Show details for subtopology {subtopology_id} in streams group {group_id}, cluster {cluster_id}.
        slots:
          subtopology_id: path.subtopology_id
          group_id: path.group_id
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List members of a streams group
      effect: read
      questions:
      - Which Kafka Streams instances are currently members of my streams group?
      - Can I see how many members have joined a streams group?
      instructions:
      - text: List the members of streams group {group_id} on cluster {cluster_id}.
        slots:
          group_id: path.group_id
          cluster_id: path.cluster_id
      - text: Show all instances that belong to Kafka Streams 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}/streams-groups/{group_id}/members/{member_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one member of a streams group
      effect: read
      questions:
      - What do I know about a single member of a Kafka Streams group?
      - How do I look up one streams group member by member ID?
      instructions:
      - text: Get member {member_id} of streams group {group_id} on cluster {cluster_id}.
        slots:
          member_id: path.member_id
          group_id: path.group_id
          cluster_id: path.cluster_id
      - text: Show details of streams member {member_id} in group {group_id}, cluster {cluster_id}.
        slots:
          member_id: path.member_id
          group_id: path.group_id
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a streams member's current assignments
      effect: read
      questions:
      - Which tasks is a Kafka Streams member currently assigned?
      - Can I see the current (not target) assignment of one streams group member?
      instructions:
      - text: Get the current assignments of member {member_id} in streams group {group_id} on cluster {cluster_id}.
        slots:
          member_id: path.member_id
          group_id: path.group_id
          cluster_id: path.cluster_id
      - text: Show what streams member {member_id} of group {group_id} is working on now, cluster {cluster_id}.
        slots:
          member_id: path.member_id
          group_id: path.group_id
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a streams member's target assignments
      effect: read
      questions:
      - What is the target assignment a streams member is being rebalanced toward?
      - Can I compare where a Kafka Streams member is headed after a rebalance?
      instructions:
      - text: Get the target assignments of member {member_id} in streams group {group_id} on cluster {cluster_id}.
        slots:
          member_id: path.member_id
          group_id: path.group_id
          cluster_id: path.cluster_id
      - text: Show which tasks streams member {member_id} of group {group_id} should end up with, cluster {cluster_id}.
        slots:
          member_id: path.member_id
          group_id: path.group_id
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments/{assignments_type}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a member's current tasks of one type
      effect: read
      questions:
      - Which active or standby tasks does a streams member currently hold?
      - Can I filter a streams member's current assignment to a single task type?
      instructions:
      - text: List the current {assignments_type} tasks of member {member_id} in streams group {group_id}, cluster {cluster_id}.
        slots:
          assignments_type: path.assignments_type
          member_id: path.member_id
          group_id: path.group_id
          cluster_id: path.cluster_id
      - text: Show member {member_id}'s assigned {assignments_type} tasks now in group {group_id} on cluster {cluster_id}.
        slots:
          member_id: path.member_id
          assignments_type: path.assignments_type
          group_id: path.group_id
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments/{assignments_type}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a member's target tasks of one type
      effect: read
      questions:
      - Which tasks of a given type will a streams member hold once rebalancing finishes?
      - Can I see only the target standby or active tasks planned for a streams member?
      instructions:
      - text: List the target {assignments_type} tasks for member {member_id} in streams group {group_id}, cluster {cluster_id}.
        slots:
          assignments_type: path.assignments_type
          member_id: path.member_id
          group_id: path.group_id
          cluster_id: path.cluster_id
      - text: Show the planned {assignments_type} tasks for streams member {member_id}, group {group_id}, cluster {cluster_id}.
        slots:
          assignments_type: path.assignments_type
          member_id: path.member_id
          group_id: path.group_id
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/assignments/{assignments_type}/subtopologies/{subtopology_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List partitions of a member's current subtopology tasks
      effect: read
      questions:
      - Which partitions does a streams member currently own for one subtopology?
      - How do I drill into the partitions behind a member's current tasks in a subtopology?
      instructions:
      - text: List the partitions of member {member_id}'s current {assignments_type} tasks in subtopology {subtopology_id}, group {group_id}, cluster {cluster_id}.
        slots:
          member_id: path.member_id
          assignments_type: path.assignments_type
          subtopology_id: path.subtopology_id
          group_id: path.group_id
          cluster_id: path.cluster_id
      - text: Show current task partitions for streams member {member_id}, type {assignments_type}, subtopology {subtopology_id}, group {group_id} on {cluster_id}.
        slots:
          member_id: path.member_id
          assignments_type: path.assignments_type
          subtopology_id: path.subtopology_id
          group_id: path.group_id
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id}/target-assignments/{assignments_type}/subtopologies/{subtopology_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List partitions of a member's target subtopology tasks
      effect: read
      questions:
      - Which partitions will a streams member be given for one subtopology after the rebalance?
      - Can I see the target partition assignment for a member's tasks in a single subtopology?
      instructions:
      - text: List the target partitions of member {member_id}'s {assignments_type} tasks in subtopology {subtopology_id}, group {group_id}, cluster {cluster_id}.
        slots:
          member_id: path.member_id
          assignments_type: path.assignments_type
          subtopology_id: path.subtopology_id
          group_id: path.group_id
          cluster_id: path.cluster_id
      - text: Show planned task partitions for streams member {member_id}, type {assignments_type}, subtopology {subtopology_id}, group {group_id} on {cluster_id}.
        slots:
          member_id: path.member_id
          assignments_type: path.assignments_type
          subtopology_id: path.subtopology_id
          group_id: path.group_id
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'