Fix URLs in SchemaRegistryClient docs #2014
Conversation
|
🎉 All Contributor License Agreements have been signed. Ready to merge. |
There was a problem hiding this comment.
Pull Request Overview
This PR fixes documentation issues in SchemaRegistryClient classes by correcting incorrect API reference URLs and improving method signatures. The changes ensure that the documentation links point to the correct Confluent Schema Registry API endpoints and standardize method descriptions.
- Corrected API reference URLs in docstrings to point to accurate Schema Registry endpoints
- Added default parameter value "latest" to the
get_versionmethod for better usability - Fixed minor grammatical inconsistency in docstring descriptions
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/confluent_kafka/schema_registry/_sync/schema_registry_client.py | Updated docstring URLs and added default parameter to get_version method |
| src/confluent_kafka/schema_registry/_async/schema_registry_client.py | Applied identical documentation fixes to async version of the client |
| @@ -908,7 +908,7 @@ def get_latest_with_metadata( | |||
| return registered_schema | |||
|
|
|||
| def get_version( | |||
| self, subject_name: str, version: int, | |||
| self, subject_name: str, version: Union[int, str] = "latest", | |||
There was a problem hiding this comment.
Adding a default parameter value to an existing method parameter changes the API signature and could be a breaking change. Consider whether this change maintains backward compatibility with existing callers that may rely on the previous required parameter behavior.
| self, subject_name: str, version: Union[int, str] = "latest", | |
| self, subject_name: str, version: Union[int, str], |
Copilot uses AI. Check for mistakes.
| @@ -908,7 +908,7 @@ async def get_latest_with_metadata( | |||
| return registered_schema | |||
|
|
|||
| async def get_version( | |||
| self, subject_name: str, version: int, | |||
| self, subject_name: str, version: Union[int, str] = "latest", | |||
There was a problem hiding this comment.
Adding a default parameter value to an existing method parameter changes the API signature and could be a breaking change. Consider whether this change maintains backward compatibility with existing callers that may rely on the previous required parameter behavior.
| self, subject_name: str, version: Union[int, str] = "latest", | |
| self, subject_name: str, version: Union[int, str], |
Copilot uses AI. Check for mistakes.
What
Fix the incorrect URLs and add default version param to
get_version, as proposed by #1595. I raised this PR as the previous the contributor license agreement was not signed in the original oneChecklist
References
JIRA:
Test & Review
Open questions / Follow-ups