Skip to content

MINOR: Add entity types in streams group RPCs #19979

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 18, 2025

Conversation

lucasbru
Copy link
Member

@lucasbru lucasbru commented Jun 17, 2025

These can be used to implement transformations on top of the RPC
definitions. Group IDs were already marked. This PR additionally adds
the entityType for all topic names.

Reviewers: Matthias J. Sax [email protected]

@lucasbru lucasbru requested review from Copilot and mjsax June 17, 2025 12:17
@github-actions github-actions bot added clients small Small PRs labels Jun 17, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Adds entityType metadata to various fields in the StreamsGroup RPC JSON schemas to support transformations on RPC definitions.

  • Introduces entityType for error messages and topic names in heartbeat and describe RPC responses
  • Fixes a comment typo in the StreamsGroupHeartbeatRequest header
  • Adds entityType for topic fields in heartbeat request and describe response schemas

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
clients/src/main/resources/common/message/StreamsGroupHeartbeatResponse.json Added entityType to ErrorMessage, StatusDetail, and Topic fields
clients/src/main/resources/common/message/StreamsGroupHeartbeatRequest.json Corrected header comment and added entityType to SourceTopics, RepartitionSinkTopics, and TopicInfo Name
clients/src/main/resources/common/message/StreamsGroupDescribeResponse.json Added entityType to ErrorMessage, SourceTopics, RepartitionSinkTopics, and TopicInfo Name
Comments suppressed due to low confidence (4)

clients/src/main/resources/common/message/StreamsGroupHeartbeatResponse.json:43

  • Consider adding or updating unit tests to verify that the new entityType attribute for ErrorMessage is correctly parsed and applied in downstream transformations.
    { "name": "ErrorMessage", "type": "string", "versions": "0+", "nullableVersions": "0+", "default": "null", "entityType": "errorMessage",

clients/src/main/resources/common/message/StreamsGroupHeartbeatRequest.json:53

  • Add tests to ensure that entityType: \"topicName\" on SourceTopics is correctly handled by any schema validation or code generation tools that consume these JSON files.
            { "name": "SourceTopics", "type": "[]string", "versions": "0+", "entityType": "topicName",

clients/src/main/resources/common/message/StreamsGroupDescribeResponse.json:39

  • Introduce or update integration tests to confirm that downstream consumers receive and interpret the entityType metadata on ErrorMessage as expected.
        { "name": "ErrorMessage", "type": "string", "versions": "0+", "nullableVersions": "0+", "default": "null", "entityType": "errorMessage",

clients/src/main/resources/common/message/StreamsGroupHeartbeatRequest.json:23

  • [nitpick] Consider adding a brief note in the file header or a shared spec document explaining the purpose and allowed values for the new entityType property so it's clear to future readers.
  // The StreamsGroupHeartbeatRequest API is added as part of KIP-1071 and is still under

These can be used to implement transformations on top of the RPC
definitions. Group IDs were already marked. This PR additionally
adds the entityType for topic names.
@lucasbru lucasbru added streams KIP-1071 PRs related to KIP-1071 labels Jun 18, 2025
@lucasbru lucasbru merged commit 788781d into apache:trunk Jun 18, 2025
26 checks passed
lucasbru added a commit that referenced this pull request Jun 18, 2025
These can be used to implement transformations on top of the RPC
definitions. Group IDs were already marked. This PR additionally adds
the entityType for all topic names.

Reviewers: Matthias J. Sax <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clients KIP-1071 PRs related to KIP-1071 small Small PRs streams
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants