Add missing endpoints (/compatibility, /mode) to SchemaRegistryClient #2024

fangnx · 2025-08-18T20:36:26Z

What

Add the missing endpoints and update the existing ones to SR client, for /compatibility and /mode endpoints.

Checklist

Contains customer facing changes? Including API/behavior changes
Did you add sufficient unit test and/or integration test coverage for this PR?
- If not, please explain why it is not required

References

JIRA: https://confluentinc.atlassian.net/browse/DGS-21591

Test & Review

Open questions / Follow-ups

confluent-cla-assistant · 2025-08-18T20:36:37Z

🎉 All Contributor License Agreements have been signed. Ready to merge.
_{Please push an empty commit if you would like to re-run the checks to verify CLA status for all contributors.}

Copilot

Pull Request Overview

Add missing endpoints /compatibility and /mode to SchemaRegistryClient with comprehensive test coverage. This PR expands the Schema Registry client functionality by implementing several new API methods for both sync and async clients.

Adds new endpoints for schema operations: get_schema_string, get_schema_types, get_schema_versions
Adds new endpoints for subject operations: get_version_schema_string, get_referenced_by
Adds compatibility testing against all versions: test_compatibility_against_all
Updates existing methods to accept new optional parameters for filtering

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
`tests/schema_registry/conftest.py`	Adds mock handlers and regex patterns for new endpoints
`tests/schema_registry/_sync/test_api_client.py`	Adds comprehensive test coverage for new sync client methods
`tests/schema_registry/_async/test_api_client.py`	Adds comprehensive test coverage for new async client methods
`tests/integration/schema_registry/_sync/test_proto_serializers.py`	Updates test to use new RegisteredSchema return type
`tests/integration/schema_registry/_async/test_proto_serializers.py`	Updates test to use new RegisteredSchema return type
`src/confluent_kafka/schema_registry/common/schema_registry_client.py`	Adds SchemaVersion class and refactors field ordering
`src/confluent_kafka/schema_registry/_sync/schema_registry_client.py`	Implements new API methods for sync client
`src/confluent_kafka/schema_registry/_async/schema_registry_client.py`	Implements new API methods for async client
`DEVELOPER.md`	Removes trailing whitespace

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-08-18T20:39:26Z

src/confluent_kafka/schema_registry/_sync/schema_registry_client.py

+            query={'normalize': normalize, 'verbose': verbose},
+            body=request,
+        )
+        return response['is_compatible'] # TODO: should it return entire response


The TODO comment indicates incomplete implementation. Consider either returning the full response or documenting why only 'is_compatible' is returned.

Suggested change

return response['is_compatible'] # TODO: should it return entire response

return response

Copilot · 2025-08-18T20:39:27Z

src/confluent_kafka/schema_registry/_async/schema_registry_client.py

+            query={'normalize': normalize, 'verbose': verbose},
+            body=request,
+        )
+        return response['is_compatible'] # TODO: should it return entire response


The TODO comment indicates incomplete implementation. Consider either returning the full response or documenting why only 'is_compatible' is returned.

Suggested change

return response['is_compatible'] # TODO: should it return entire response

return response

Copilot · 2025-08-18T20:39:27Z

src/confluent_kafka/schema_registry/_sync/schema_registry_client.py

+            subject_name (str): Name of the schema against which compatibility is to be tested.
+            schema (Schema): Schema instance.
+            normalize (bool): Whether to normalize the input schema. # TODO: missing in cp + cc docs
+            verbose (bool): Wehther to return detailed error messages.


Spelling error: 'Wehther' should be 'Whether'.

Suggested change

verbose (bool): Wehther to return detailed error messages.

verbose (bool): Whether to return detailed error messages.

Copilot · 2025-08-18T20:39:27Z

src/confluent_kafka/schema_registry/_async/schema_registry_client.py

+            subject_name (str): Name of the schema against which compatibility is to be tested.
+            schema (Schema): Schema instance.
+            normalize (bool): Whether to normalize the input schema. # TODO: missing in cp + cc docs
+            verbose (bool): Wehther to return detailed error messages.


Spelling error: 'Wehther' should be 'Whether'.

Suggested change

verbose (bool): Wehther to return detailed error messages.

verbose (bool): Whether to return detailed error messages.

Nice to have copilot find typos to save reading for them :D

Copilot · 2025-08-18T20:39:28Z

src/confluent_kafka/schema_registry/_sync/schema_registry_client.py

+        Args:
+            subject_name (str): Name of the schema against which compatibility is to be tested.
+            schema (Schema): Schema instance.
+            normalize (bool): Whether to normalize the input schema. # TODO: missing in cp + cc docs


The TODO comment suggests incomplete documentation. Consider either updating the documentation or removing the comment if it's not actionable.

Suggested change

normalize (bool): Whether to normalize the input schema. # TODO: missing in cp + cc docs

normalize (bool): Whether to normalize the input schema.

Copilot · 2025-08-18T20:39:28Z

src/confluent_kafka/schema_registry/_async/schema_registry_client.py

+        Args:
+            subject_name (str): Name of the schema against which compatibility is to be tested.
+            schema (Schema): Schema instance.
+            normalize (bool): Whether to normalize the input schema. # TODO: missing in cp + cc docs


The TODO comment suggests incomplete documentation. Consider either updating the documentation or removing the comment if it's not actionable.

Suggested change

normalize (bool): Whether to normalize the input schema. # TODO: missing in cp + cc docs

normalize (bool): Whether to normalize the input schema.

MSeal · 2025-08-18T21:43:32Z

src/confluent_kafka/schema_registry/_async/schema_registry_client.py

+            subject_name (str): Name of the schema against which compatibility is to be tested.
+            schema (Schema): Schema instance.
+            normalize (bool): Whether to normalize the input schema. # TODO: missing in cp + cc docs
+            verbose (bool): Wehther to return detailed error messages.


Nice to have copilot find typos to save reading for them :D

MSeal · 2025-08-18T21:52:58Z

src/confluent_kafka/schema_registry/_async/schema_registry_client.py

        )
+        return response['is_compatible']  # TODO: should it return entire response (including error messages)?


Maybe return a tuple [bool, Response] so it's easy to have a simple response vs a parsing the complex object? But I think this should probably return the full response by itself with a reference in the docstring to the is_compatible as a likely attribute for consumption.

My concern is this would be a breaking change, although in this case I think it might be necessary to just make the change (or add a separate method and mark this one as @deprecated): not sure how customers usually interact with test_compatibility, but intuitively I think the "messages" field for test_compatibility is important to include
cc @rayokota if you have any thoughts on this :)

MSeal · 2025-08-18T22:01:31Z

src/confluent_kafka/schema_registry/_sync/schema_registry_client.py

+            `GET Global Mode API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#get--mode>`_
+        """  # noqa: E501
+        result = self._rest_client.get('mode')
+        return result['mode']


Consider a debug log here with the result if you're not returning the full payload so the contents aren't lost (or maybe generally have a logging debug level option for all rest requests made to SR service)

sonarqube-confluent · 2025-08-20T18:33:16Z

Analysis Details

12 Issues

0 Bugs
0 Vulnerabilities
12 Code Smells

Coverage and Duplications

100.00% Coverage (66.60% Estimated after merge)
No duplication information (5.60% Estimated after merge)

Project ID: confluent-kafka-python

View in SonarQube

fangnx marked this pull request as ready for review August 18, 2025 20:37

Copilot AI review requested due to automatic review settings August 18, 2025 20:37

fangnx requested review from MSeal and a team as code owners August 18, 2025 20:37

fangnx changed the base branch from master to sr-endpoints-add-1 August 18, 2025 20:38

Copilot AI reviewed Aug 18, 2025

View reviewed changes

airlock-confluentinc bot force-pushed the sr-endpoints-add-2 branch from ddf1826 to dc8d820 Compare August 18, 2025 20:40

This comment has been minimized.

Sign in to view

fangnx requested a review from rayokota August 18, 2025 21:08

This comment has been minimized.

Sign in to view

MSeal requested changes Aug 18, 2025

View reviewed changes

This comment has been minimized.

Sign in to view

Base automatically changed from sr-endpoints-add-1 to master August 20, 2025 14:19

fangnx added 13 commits August 20, 2025 13:19

updaet

fa03877

update

4ff90b1

tests

d3674ff

fix integration tests

08e4b26

regenerate sync code + fix it

aa8604e

fix some unit tests broken from unasync

596477e

missing params and address feedback

24ea666

lint

a190cd6

revert breaking chamges

2358683

update

dcff38c

update

66f6882

update

bb05bb6

mode

7634f0d

fangnx added 6 commits August 20, 2025 13:35

mode

babd9bc

updaste

d61bee1

linter

d2e71da

fix typos

75400bd

update

710d390

add more

9b468a7

airlock-confluentinc bot force-pushed the sr-endpoints-add-2 branch from 7a24c92 to 9b468a7 Compare August 20, 2025 18:04

update

2c45803

This comment has been minimized.

Sign in to view

	return response['is_compatible'] # TODO: should it return entire response
	return response

	verbose (bool): Wehther to return detailed error messages.
	verbose (bool): Whether to return detailed error messages.

	normalize (bool): Whether to normalize the input schema. # TODO: missing in cp + cc docs
	normalize (bool): Whether to normalize the input schema.

Add missing endpoints (/compatibility, /mode) to SchemaRegistryClient #2024

Are you sure you want to change the base?

Add missing endpoints (/compatibility, /mode) to SchemaRegistryClient #2024

Uh oh!

Conversation

fangnx commented Aug 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Checklist

References

Test & Review

Open questions / Follow-ups

Uh oh!

confluent-cla-assistant bot commented Aug 18, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

MSeal Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

MSeal Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

MSeal Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

fangnx Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

MSeal Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

sonarqube-confluent bot commented Aug 20, 2025

Analysis Details

12 Issues

Coverage and Duplications

Uh oh!

Uh oh!

fangnx commented Aug 18, 2025 •

edited

Loading