Skip to content

Commit e9ba52e

Browse files
authored
Fix URLs in SchemaRegistryClient docs (#2014)
* fix * typo
1 parent 7039489 commit e9ba52e

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

src/confluent_kafka/schema_registry/_async/schema_registry_client.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -753,7 +753,7 @@ async def lookup_schema(
753753
SchemaRegistryError: If schema or subject can't be found
754754
755755
See Also:
756-
`POST Subject API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#post--subjects-(string-%20subject)-versions>`_
756+
`POST Subject API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#post--subjects-(string-%20subject)>`_
757757
""" # noqa: E501
758758

759759
registered_schema = self._cache.get_registered_by_subject_schema(subject_name, schema)
@@ -785,7 +785,7 @@ async def lookup_schema(
785785

786786
async def get_subjects(self) -> List[str]:
787787
"""
788-
List all subjects registered with the Schema Registry
788+
Lists all subjects registered with the Schema Registry
789789
790790
Returns:
791791
list(str): Registered subject names
@@ -794,7 +794,7 @@ async def get_subjects(self) -> List[str]:
794794
SchemaRegistryError: if subjects can't be found
795795
796796
See Also:
797-
`GET subjects API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#get--subjects-(string-%20subject)-versions>`_
797+
`GET subjects API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#get--subjects>`_
798798
""" # noqa: E501
799799

800800
return await self._rest_client.get('subjects')
@@ -908,7 +908,7 @@ async def get_latest_with_metadata(
908908
return registered_schema
909909

910910
async def get_version(
911-
self, subject_name: str, version: int,
911+
self, subject_name: str, version: Union[int, str] = "latest",
912912
deleted: bool = False, fmt: Optional[str] = None
913913
) -> 'RegisteredSchema':
914914
"""
@@ -927,7 +927,7 @@ async def get_version(
927927
SchemaRegistryError: if the version can't be found or is invalid.
928928
929929
See Also:
930-
`GET Subject Version API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#get--subjects-(string-%20subject)-versions-(versionId-%20version)>`_
930+
`GET Subject Versions API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#get--subjects-(string-%20subject)-versions>`_
931931
""" # noqa: E501
932932

933933
registered_schema = self._cache.get_registered_by_subject_version(subject_name, version)

src/confluent_kafka/schema_registry/_sync/schema_registry_client.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -753,7 +753,7 @@ def lookup_schema(
753753
SchemaRegistryError: If schema or subject can't be found
754754
755755
See Also:
756-
`POST Subject API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#post--subjects-(string-%20subject)-versions>`_
756+
`POST Subject API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#post--subjects-(string-%20subject)>`_
757757
""" # noqa: E501
758758

759759
registered_schema = self._cache.get_registered_by_subject_schema(subject_name, schema)
@@ -785,7 +785,7 @@ def lookup_schema(
785785

786786
def get_subjects(self) -> List[str]:
787787
"""
788-
List all subjects registered with the Schema Registry
788+
Lists all subjects registered with the Schema Registry
789789
790790
Returns:
791791
list(str): Registered subject names
@@ -794,7 +794,7 @@ def get_subjects(self) -> List[str]:
794794
SchemaRegistryError: if subjects can't be found
795795
796796
See Also:
797-
`GET subjects API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#get--subjects-(string-%20subject)-versions>`_
797+
`GET subjects API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#get--subjects>`_
798798
""" # noqa: E501
799799

800800
return self._rest_client.get('subjects')
@@ -908,7 +908,7 @@ def get_latest_with_metadata(
908908
return registered_schema
909909

910910
def get_version(
911-
self, subject_name: str, version: int,
911+
self, subject_name: str, version: Union[int, str] = "latest",
912912
deleted: bool = False, fmt: Optional[str] = None
913913
) -> 'RegisteredSchema':
914914
"""
@@ -927,7 +927,7 @@ def get_version(
927927
SchemaRegistryError: if the version can't be found or is invalid.
928928
929929
See Also:
930-
`GET Subject Version API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#get--subjects-(string-%20subject)-versions-(versionId-%20version)>`_
930+
`GET Subject Versions API Reference <https://docs.confluent.io/current/schema-registry/develop/api.html#get--subjects-(string-%20subject)-versions>`_
931931
""" # noqa: E501
932932

933933
registered_schema = self._cache.get_registered_by_subject_version(subject_name, version)

0 commit comments

Comments
 (0)