Skip to content

KAFKA-20389: Filter internal keys from connector plugin config REST response#21976

Open
nileshkumar3 wants to merge 5 commits intoapache:trunkfrom
nileshkumar3:KAFKA-20389-config-key-info-internal
Open

KAFKA-20389: Filter internal keys from connector plugin config REST response#21976
nileshkumar3 wants to merge 5 commits intoapache:trunkfrom
nileshkumar3:KAFKA-20389-config-key-info-internal

Conversation

@nileshkumar3
Copy link
Copy Markdown
Contributor

@nileshkumar3 nileshkumar3 commented Apr 7, 2026

The GET /connector-plugins/{plugin}/config response used to list every key from the plugin’s ConfigDef, including internal ones. Internal keys are now filtered out, so clients only see keys that are meant to be user-facing.

@github-actions github-actions bot added triage PRs from the community connect small Small PRs labels Apr 7, 2026
@JsonProperty("dependents") List<String> dependents
@JsonProperty("dependents") List<String> dependents,
@JsonProperty("internal") boolean internal
) {
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@mimaison Since ConfigKeyInfo is a public API class and adding a new record component changes its constructor signature, does this change require a KIP? The REST API change is additive (new internal field in JSON), but Java clients constructing ConfigKeyInfo directly would break.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ConfigKeyInfo is not part of the public API. You can see all the public API classes in https://kafka.apache.org/42/javadoc/index.html

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks @mimaison, this is helpful. request your review on this PR.

@github-actions github-actions bot removed the triage PRs from the community label Apr 8, 2026
@mimaison
Copy link
Copy Markdown
Member

mimaison commented Apr 8, 2026

I'm not sure this change makes sense. See my comment in https://issues.apache.org/jira/browse/KAFKA-20389

@nileshkumar3 nileshkumar3 changed the title KAFKA-20389: Add 'internal' flag to ConfigKeyInfo KAFKA-20389: Filter internal keys from connector plugin config REST response Apr 9, 2026
@nileshkumar3
Copy link
Copy Markdown
Contributor Author

nileshkumar3 commented Apr 9, 2026

I'm not sure this change makes sense. See my comment in https://issues.apache.org/jira/browse/KAFKA-20389

I'm not sure this change makes sense. See my comment in https://issues.apache.org/jira/browse/KAFKA-20389

Changed the code as per the comment. request another round of review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants