Skip to content

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.

Sign up for GitHub

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Fix SchemaRegistryClient docs #1595

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6cc40b2
Fix documentation URLs in SchemaRegistryClient
pko-trackunit Jun 26, 2023
330a4e8
Add default value for version in SchemaRegistryClient.get_version()
pko-trackunit Jun 26, 2023
76c4c79
merge master
fangnx Jul 29, 2025
6d0e3e0
add back fixes to sync & async SR clients
fangnx Jul 29, 2025
0960634
fix typos
fangnx Jul 29, 2025
61bc97c
typo
fangnx Aug 1, 2025
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/confluent_kafka/schema_registry/_async/schema_registry_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -753,7 +753,7 @@ async def lookup_schema(
SchemaRegistryError: If schema or subject can't be found

See Also:
`POST Subject API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#post--subjects-(string-%20subject)-versions>`_
`POST Subject API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#post--subjects-(string-%20subject)>`_
""" # noqa: E501

registered_schema = self._cache.get_registered_by_subject_schema(subject_name, schema)
Expand Down Expand Up @@ -794,7 +794,7 @@ async def get_subjects(self) -> List[str]:
SchemaRegistryError: if subjects can't be found

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/current/schema-registry/develop/api.html#get--subjects>`_
""" # noqa: E501

return await self._rest_client.get('subjects')
Expand Down Expand Up @@ -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",
deleted: bool = False, fmt: Optional[str] = None
) -> 'RegisteredSchema':
"""
Expand Down Expand Up @@ -959,7 +959,7 @@ async def get_versions(self, subject_name: str) -> List[int]:
SchemaRegistryError: If subject can't be found

See Also:
`GET Subject Versions API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#post--subjects-(string-%20subject)-versions>`_
`GET Subject Versions API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#get--subjects-(string-%20subject)-versions>`_
""" # noqa: E501

return await self._rest_client.get('subjects/{}/versions'.format(_urlencode(subject_name)))
Expand Down
8 changes: 4 additions & 4 deletions src/confluent_kafka/schema_registry/_sync/schema_registry_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -753,7 +753,7 @@ def lookup_schema(
SchemaRegistryError: If schema or subject can't be found

See Also:
`POST Subject API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#post--subjects-(string-%20subject)-versions>`_
`POST Subject API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#post--subjects-(string-%20subject)>`_
""" # noqa: E501

registered_schema = self._cache.get_registered_by_subject_schema(subject_name, schema)
Expand Down Expand Up @@ -794,7 +794,7 @@ def get_subjects(self) -> List[str]:
SchemaRegistryError: if subjects can't be found

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/current/schema-registry/develop/api.html#get--subjects>`_
""" # noqa: E501

return self._rest_client.get('subjects')
Expand Down Expand Up @@ -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",
Copy link

Copilot AI Jul 29, 2025

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).

Suggested change
self, subject_name: str, version: Union[int, str] = "latest",
self, subject_name: str, version: Union[int, str] = "latest", *,
Copilot uses AI. Check for mistakes.
deleted: bool = False, fmt: Optional[str] = None
) -> 'RegisteredSchema':
"""
Expand Down Expand Up @@ -959,7 +959,7 @@ def get_versions(self, subject_name: str) -> List[int]:
SchemaRegistryError: If subject can't be found

See Also:
`GET Subject Versions API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#post--subjects-(string-%20subject)-versions>`_
`GET Subject Versions API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#get--subjects-(string-%20subject)-versions>`_
""" # noqa: E501

return self._rest_client.get('subjects/{}/versions'.format(_urlencode(subject_name)))
Expand Down