# 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-the-data-streaming-platform-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 cluster?
      - Can I see every streams group running against a Confluent Kafka cluster?
      instructions:
      - text: List the streams groups on cluster {cluster}.
        slots:
          cluster: path.cluster_id
      - text: Show me all Kafka Streams groups in {cluster}.
        slots:
          cluster: 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?
      - Where can I look up a single streams group by its group ID?
      instructions:
      - text: Get streams group {group} on cluster {cluster}.
        slots:
          group: path.group_id
          cluster: path.cluster_id
      - text: Show the details of Kafka Streams group {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}/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 application's topology?
      - Can I list the subtopologies a streams group is processing?
      instructions:
      - text: List the subtopologies of streams group {group} on cluster {cluster}.
        slots:
          group: path.group_id
          cluster: path.cluster_id
      - text: Show every subtopology in {group}.
        slots:
          group: path.group_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 and partitions does one specific subtopology use?
      - Can I inspect a single subtopology by its ID?
      instructions:
      - text: Get subtopology {subtopology} of streams group {group} on cluster {cluster}.
        slots:
          subtopology: path.subtopology_id
          group: path.group_id
          cluster: path.cluster_id
      - text: Show me the details of subtopology {subtopology} in {group}.
        slots:
          subtopology: path.subtopology_id
          group: path.group_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 instances are currently members of my Kafka Streams group?
      - How many members has a streams group got right now?
      instructions:
      - text: List the members of streams group {group} on cluster {cluster}.
        slots:
          group: path.group_id
          cluster: path.cluster_id
      - text: Show all Streams instances that joined {group}.
        slots:
          group: path.group_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 we know about one particular member of a streams group?
      - Can I look up a streams group member by its member ID?
      instructions:
      - text: Get member {member} of streams group {group} on cluster {cluster}.
        slots:
          member: path.member_id
          group: path.group_id
          cluster: path.cluster_id
      - text: Show details for Streams member {member} in {group}.
        slots:
          member: path.member_id
          group: path.group_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:
      - What tasks is a streams group member currently assigned?
      - Can I see the current task assignment summary for one Streams instance?
      instructions:
      - text: Get the current assignments of member {member} in streams group {group} on cluster {cluster}.
        slots:
          member: path.member_id
          group: path.group_id
          cluster: path.cluster_id
      - text: Show what member {member} of {group} is assigned right now.
        slots:
          member: path.member_id
          group: path.group_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 moved toward during a rebalance?
      - Can I compare where a Streams instance is heading versus what it holds now?
      instructions:
      - text: Get the target assignments of member {member} in streams group {group} on cluster {cluster}.
        slots:
          member: path.member_id
          group: path.group_id
          cluster: path.cluster_id
      - text: Show the rebalance target for member {member} of {group}.
        slots:
          member: path.member_id
          group: path.group_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, standby or warmup tasks does a streams member currently own?
      - Can I filter a member's current assignment down to a single task type?
      instructions:
      - text: List the current {type} tasks of member {member} in streams group {group} on cluster {cluster}.
        slots:
          type: path.assignments_type
          member: path.member_id
          group: path.group_id
          cluster: path.cluster_id
      - text: Show member {member}'s currently assigned {type} tasks in {group}.
        slots:
          type: path.assignments_type
          member: path.member_id
          group: path.group_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 is a streams member slated to receive after rebalancing?
      - Can I see just the target standby tasks planned for one Streams instance?
      instructions:
      - text: List the target {type} tasks for member {member} in streams group {group} on cluster {cluster}.
        slots:
          type: path.assignments_type
          member: path.member_id
          group: path.group_id
          cluster: path.cluster_id
      - text: Show the {type} tasks member {member} of {group} will be given once the rebalance settles.
        slots:
          type: path.assignments_type
          member: path.member_id
          group: path.group_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 current task partitions for a subtopology
      effect: read
      questions:
      - Which partitions does a member currently process for one subtopology?
      - Can I drill into a member's current assignment by task type and subtopology?
      instructions:
      - text: List the current {type} task partitions of member {member} for subtopology {subtopology} in group {group} on cluster {cluster}.
        slots:
          type: path.assignments_type
          member: path.member_id
          subtopology: path.subtopology_id
          group: path.group_id
          cluster: path.cluster_id
      - text: Show which partitions member {member} is processing now for subtopology {subtopology}.
        slots:
          member: path.member_id
          subtopology: path.subtopology_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 target task partitions for a subtopology
      effect: read
      questions:
      - Which partitions will a member be given for one subtopology once rebalancing finishes?
      - Can I see a member's planned partitions for a subtopology before they move?
      instructions:
      - text: Show the {type} partitions member {member} will own after rebalancing for subtopology {subtopology} in group {group} on cluster {cluster}.
        slots:
          type: path.assignments_type
          member: path.member_id
          subtopology: path.subtopology_id
          group: path.group_id
          cluster: path.cluster_id
      - text: Show the partitions member {member} is slated to take over for subtopology {subtopology}.
        slots:
          member: path.member_id
          subtopology: path.subtopology_id
      method: generated
      generated: '2026-09-26'