- Notifications
You must be signed in to change notification settings - Fork 934
Fix SchemaRegistryClient docs #1595
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
base: master
Are you sure you want to change the base?
Fix SchemaRegistryClient docs #1595
Conversation
| Also, it feels like |
|
|
| Hi @pko-trackunit, thanks for raising the PR. I double checked and the two doc URLs you fixed and the one for
|
| See Also: | ||
| `GET subjects API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#get--subjects-(string-%20subject)-versions>`_ | ||
| `GET subjects API Reference <https://docs.confluent.io/platform/current/schema-registry/develop/api.html#get--subjects>`_ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's omit the /platform part (which will be added during redirection) of the URl to stay consistent with the rest of URLs in docs
| All contributors need to sign the Contributor License Agreement here before this PR can be approved. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR fixes documentation issues in SchemaRegistryClient by correcting mismatched API reference URLs and adding a missing default value for the version parameter.
- Corrected four API reference URLs in docstrings to point to the correct endpoints
- Added default value "latest" to the version parameter in get_version method
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/confluent_kafka/schema_registry/_sync/schema_registry_client.py | Fixed API reference URLs in docstrings and added default value for version parameter |
| src/confluent_kafka/schema_registry/_async/schema_registry_client.py | Same fixes as sync version - corrected URLs and added version parameter default |
| | ||
| def get_version( | ||
| self, subject_name: str, version: int, | ||
| self, subject_name: str, version: Union[int, str] = "latest", |
Copilot AI Jul 29, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding a default value to an existing parameter is a breaking change for callers using positional arguments. Consider whether this change maintains backward compatibility with existing code that may call get_version(subject, version, deleted=True).
| self, subject_name: str, version: Union[int, str] = "latest", | |
| self, subject_name: str, version: Union[int, str] = "latest", *, |
| /sem-approve |
Fixed few mismached URLs and missing default value for a parameter.