[SchemaRegistry] final api review changes (#21589)

Author: swathipil

sdk/schemaregistry/azure-schemaregistry/CHANGELOG.md

@@ -13,9 +13,15 @@
 - `SchemaProperties` has the following instance variables: `id`, `format`, `version`.
 - `Schema` has the following properties: `properties` and `schema_definition`.
 - `SchemaFormat` provides the schema format to be stored by the service. Currently, the only supported format is `Avro`.
+- `api_version` has been added as a keyword arg to the sync and async `SchemaRegistryClient` constructors
 
 ### Breaking Changes
 
+- `version` instance variable in `SchemaProperties` has been removed.  
+- `schema_definition` instance variable in `Schema` has been renamed `definition`.
+- `id` parameter in `get_schema` method on sync and async `SchemaRegistryClient` has been renamed `schema_id`.
+- `name` parameter in `register_schema` and `get_schema_properties` methods on sync and async `SchemaRegistryClient` has been renamed `schema_name`.
+
 ### Bugs Fixed
 
 ### Other Changes

sdk/schemaregistry/azure-schemaregistry/README.md

@@ -86,7 +86,7 @@ from azure.schemaregistry import SchemaRegistryClient
 token_credential = DefaultAzureCredential()
 fully_qualified_namespace = os.environ['SCHEMA_REGISTRY_FULLY_QUALIFIED_NAMESPACE']
 group_name = os.environ['SCHEMA_REGISTRY_GROUP']
-name = "your-schema-name"
+schema_name = "your-schema-name"
 format = "Avro"
 schema_definition = """
 {"namespace": "example.avro",
@@ -102,7 +102,7 @@ schema_definition = """
 
 schema_registry_client = SchemaRegistryClient(fully_qualified_namespace=fully_qualified_namespace, credential=token_credential)
 with schema_registry_client:
-    schema_properties = schema_registry_client.register_schema(group_name, name, schema_definition, format)
+    schema_properties = schema_registry_client.register_schema(group_name, schema_name, schema_definition, format)
     id = schema_properties.id
 ```
 
@@ -118,12 +118,13 @@ from azure.schemaregistry import SchemaRegistryClient
 
 token_credential = DefaultAzureCredential()
 fully_qualified_namespace = os.environ['SCHEMA_REGISTRY_FULLY_QUALIFIED_NAMESPACE']
-id = 'your-schema-id'
+schema_id = 'your-schema-id'
 
 schema_registry_client = SchemaRegistryClient(fully_qualified_namespace=fully_qualified_namespace, credential=token_credential)
 with schema_registry_client:
-    schema = schema_registry_client.get_schema(id)
-    schema_definition = schema.schema_definition
+    schema = schema_registry_client.get_schema(schema_id)
+    definition = schema.definition
+    properties = schema.properties
 ```
 
 ### Get the id of a schema
@@ -139,7 +140,7 @@ from azure.schemaregistry import SchemaRegistryClient
 token_credential = DefaultAzureCredential()
 fully_qualified_namespace = os.environ['SCHEMA_REGISTRY_FULLY_QUALIFIED_NAMESPACE']
 group_name = os.environ['SCHEMA_REGISTRY_GROUP']
-name = "your-schema-name"
+schema_name = "your-schema-name"
 format = "Avro"
 schema_definition = """
 {"namespace": "example.avro",
@@ -155,7 +156,7 @@ schema_definition = """
 
 schema_registry_client = SchemaRegistryClient(fully_qualified_namespace=fully_qualified_namespace, credential=token_credential)
 with schema_registry_client:
-    schema_properties = schema_registry_client.register_schema(group_name, name, schema_definition, format)
+    schema_properties = schema_registry_client.register_schema(group_name, schema_name, schema_definition, format)
     id = schema_properties.id
 ```
 

sdk/schemaregistry/azure-schemaregistry/azure/schemaregistry/__init__.py

@@ -27,10 +27,11 @@
 __version__ = VERSION
 
 from ._schema_registry_client import SchemaRegistryClient
-from ._common._constants import SchemaFormat
+from ._common._constants import SchemaFormat, ApiVersion
 from ._common._schema import Schema, SchemaProperties
 
 __all__ = [
+    "ApiVersion",
     "SchemaRegistryClient",
     "SchemaFormat",
     "Schema",

sdk/schemaregistry/azure-schemaregistry/azure/schemaregistry/_common/_constants.py

@@ -33,3 +33,14 @@ class SchemaFormat(str, Enum):
 
     AVRO = "avro"
     """Represents the Apache Avro schema format."""
+
+class ApiVersion(str, Enum):
+    """
+    Represents the Schema Registry API version to use for requests.
+    """
+
+    V2021_10 = "2021-10"
+    """This is the default version."""
+
+
+DEFAULT_VERSION = ApiVersion.V2021_10

sdk/schemaregistry/azure-schemaregistry/azure/schemaregistry/_common/_response_handlers.py

@@ -29,8 +29,7 @@
 def _parse_schema_properties_dict(response):
     return {
         'id': response.headers.get('schema-id'),
-        'format': response.headers.get('serialization-type'),
-        'version': int(response.headers.get('schema-version'))
+        'format': response.headers.get('serialization-type')
     }
 
 
@@ -44,6 +43,6 @@ def _parse_response_schema_properties(response):
 
 def _parse_response_schema(response):
     return Schema(
-        schema_definition=response.text(),
+        definition=response.text(),
         properties=SchemaProperties(**_parse_schema_properties_dict(response))
     )

sdk/schemaregistry/azure-schemaregistry/azure/schemaregistry/_common/_schema.py

@@ -42,30 +42,29 @@ def __init__(self, **kwargs):
         # type: (Any) -> None
         self.id = kwargs.pop("id")
         self.format = kwargs.pop("format")
-        self.version = kwargs.pop("version")
 
     def __repr__(self):
-        return "SchemaProperties(id={}, format={}, version={})".format(
-            self.id, self.format, self.version
+        return "SchemaProperties(id={}, format={})".format(
+            self.id, self.format
         )[:1024]
 
 
 class Schema(object):
     """
     The schema content of a schema, along with id and meta properties.
 
-    :ivar schema_definition: The content of the schema.
-    :vartype schema_definition: str
+    :ivar definition: The content of the schema.
+    :vartype definition: str
     :ivar properties: The properties of the schema.
     :vartype properties: SchemaProperties
     """
 
     def __init__(self, **kwargs):
         # type: (Any) -> None
-        self.schema_definition = kwargs.pop("schema_definition")
+        self.definition = kwargs.pop("definition")
         self.properties = kwargs.pop("properties")
 
     def __repr__(self):
-        return "Schema(schema_definition={}, properties={})".format(
-            self.schema_definition, self.properties
+        return "Schema(definition={}, properties={})".format(
+            self.definition, self.properties
         )[:1024]

sdk/schemaregistry/azure-schemaregistry/azure/schemaregistry/_schema_registry_client.py

@@ -26,7 +26,7 @@
 from typing import Any, TYPE_CHECKING, Union
 
 from ._utils import get_http_request_kwargs
-from ._common._constants import SchemaFormat
+from ._common._constants import SchemaFormat, DEFAULT_VERSION
 from ._common._schema import Schema, SchemaProperties
 from ._common._response_handlers import (
     _parse_response_schema,
@@ -48,6 +48,8 @@ class SchemaRegistryClient(object):
      For example: my-namespace.servicebus.windows.net.
     :param credential: To authenticate managing the entities of the SchemaRegistry namespace.
     :type credential: ~azure.core.credentials.TokenCredential
+    :keyword str api_version: The Schema Registry service API version to use for requests.
+        Default value and only accepted value currently is "2021-10".
 
     .. admonition:: Example:
 
@@ -62,8 +64,12 @@ class SchemaRegistryClient(object):
 
     def __init__(self, fully_qualified_namespace, credential, **kwargs):
         # type: (str, TokenCredential, Any) -> None
+        api_version = kwargs.pop("api_version", DEFAULT_VERSION)
         self._generated_client = AzureSchemaRegistry(
-            credential=credential, endpoint=fully_qualified_namespace, **kwargs
+            credential=credential,
+            endpoint=fully_qualified_namespace,
+            api_version=api_version,
+            **kwargs
         )
 
     def __enter__(self):
@@ -83,7 +89,12 @@ def close(self):
         self._generated_client.close()
 
     def register_schema(
-        self, group_name, name, schema_definition, format, **kwargs  # pylint:disable=redefined-builtin
+        self,
+        group_name,
+        schema_name,
+        schema_definition,
+        format,
+        **kwargs  # pylint:disable=redefined-builtin
     ):
         # type: (str, str, str, Union[str, SchemaFormat], Any) -> SchemaProperties
         """
@@ -92,7 +103,7 @@ def register_schema(
         schema is created at latest version + 1.
 
         :param str group_name: Schema group under which schema should be registered.
-        :param str name: Name of schema being registered.
+        :param str schema_name: Name of schema being registered.
         :param str schema_definition: String representation of the schema being registered.
         :param format: Format for the schema being registered.
          For now Avro is the only supported schema format by the service.
@@ -118,7 +129,7 @@ def register_schema(
         http_request_kwargs = get_http_request_kwargs(kwargs)
         request = schema_rest.build_register_request(
             group_name=group_name,
-            schema_name=name,
+            schema_name=schema_name,
             content=schema_definition,
             serialization_type=format,
             content_type=kwargs.pop("content_type", "application/json"),
@@ -129,13 +140,13 @@ def register_schema(
         response.raise_for_status()
         return _parse_response_schema_properties(response)
 
-    def get_schema(self, id, **kwargs):  # pylint:disable=redefined-builtin
+    def get_schema(self, schema_id, **kwargs):
         # type: (str, Any) -> Schema
         """
         Gets a registered schema by its unique ID.
         Azure Schema Registry guarantees that ID is unique within a namespace.
 
-        :param str id: References specific schema in registry namespace.
+        :param str schema_id: References specific schema in registry namespace.
         :rtype: ~azure.schemaregistry.Schema
         :raises: :class:`~azure.core.exceptions.HttpResponseError`
 
@@ -150,21 +161,28 @@ def get_schema(self, id, **kwargs):  # pylint:disable=redefined-builtin
 
         """
         http_request_kwargs = get_http_request_kwargs(kwargs)
-        request = schema_rest.build_get_by_id_request(schema_id=id, **http_request_kwargs)
+        request = schema_rest.build_get_by_id_request(
+            schema_id=schema_id, **http_request_kwargs
+        )
         response = self._generated_client.send_request(request, **kwargs)
         response.raise_for_status()
         return _parse_response_schema(response)
 
     def get_schema_properties(
-        self, group_name, name, schema_definition, format, **kwargs  # pylint:disable=redefined-builtin
+        self,
+        group_name,
+        schema_name,
+        schema_definition,
+        format,
+        **kwargs  # pylint:disable=redefined-builtin
     ):
         # type: (str, str, str, Union[str, SchemaFormat], Any) -> SchemaProperties
         """
         Gets the schema properties corresponding to an existing schema within the specified schema group,
         as matched by schema definition comparison.
 
         :param str group_name: Schema group under which schema should be registered.
-        :param str name: Name of schema being registered.
+        :param str schema_name: Name of schema being registered.
         :param str schema_definition: String representation of the schema being registered.
         :param format: Format for the schema being registered.
         :type format: Union[str, SchemaFormat]
@@ -189,7 +207,7 @@ def get_schema_properties(
         http_request_kwargs = get_http_request_kwargs(kwargs)
         request = schema_rest.build_query_id_by_content_request(
             group_name=group_name,
-            schema_name=name,
+            schema_name=schema_name,
             content=schema_definition,
             serialization_type=format,
             content_type=kwargs.pop("content_type", "application/json"),