add name, group_name to schema_properties (Azure#24047)

Author: swathipil

sdk/schemaregistry/azure-schemaregistry/CHANGELOG.md

@@ -6,6 +6,8 @@ This version and all future versions will require Python 3.6+. Python 2.7 is no
 
 ### Features Added
 
+- `group_name` and `name` have been added as instance variables to `SchemaProperties`.
+
 ### Breaking Changes
 
 ### Bugs Fixed

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

@@ -24,9 +24,10 @@
 #
 # --------------------------------------------------------------------------
 from enum import Enum
+from azure.core import CaseInsensitiveEnumMeta
 
 
-class SchemaFormat(str, Enum):
+class SchemaFormat(str, Enum, metaclass=CaseInsensitiveEnumMeta):
     """
     Represents the format of the schema to be stored by the Schema Registry service.
     """
@@ -35,7 +36,7 @@ class SchemaFormat(str, Enum):
     """Represents the Apache Avro schema format."""
 
 
-class ApiVersion(str, Enum):
+class ApiVersion(str, Enum, metaclass=CaseInsensitiveEnumMeta):
     """
     Represents the Schema Registry API version to use for requests.
     """

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

@@ -28,7 +28,11 @@
 
 
 def _parse_schema_properties_dict(response):
-    return {"id": response.headers.get("schema-id")}
+    return {
+        "id": response.headers.get("schema-id"),
+        "group_name": response.headers.get("schema-group-name"),
+        "name": response.headers.get("schema-name")
+    }
 
 
 def _parse_response_schema_properties(response, format):

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

@@ -34,15 +34,23 @@ class SchemaProperties(object):
     :vartype id: str
     :ivar format: Format for the schema being stored.
     :vartype format: ~azure.schemaregistry.SchemaFormat
+    :ivar group_name: Schema group under which schema is stored.
+    :vartype group_name: str
+    :ivar name: Name of schema.
     """
 
     def __init__(self, **kwargs):
         # type: (Any) -> None
         self.id = kwargs.pop("id")
         self.format = kwargs.pop("format")
+        self.group_name = kwargs.pop("group_name")
+        self.name = kwargs.pop("name")
 
     def __repr__(self):
-        return "SchemaProperties(id={}, format={})".format(self.id, self.format)[:1024]
+        return (
+            f"SchemaProperties(id={self.id}, format={self.format}, "
+            f"group_name={self.group_name}, name={self.name})"[:1024]
+        )
 
 
 class Schema(object):

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

@@ -184,9 +184,9 @@ def get_schema_properties(
         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 definition: String representation of the schema being registered.
-        :param format: Format for the schema being registered.
+        :param str name: Name of schema for which properties should be retrieved.
+        :param str definition: String representation of the schema for which properties should be retrieved.
+        :param format: Format for the schema for which properties should be retrieved.
         :type format: Union[str, SchemaFormat]
         :rtype: ~azure.schemaregistry.SchemaProperties
         :raises: :class:`~azure.core.exceptions.HttpResponseError`

sdk/schemaregistry/azure-schemaregistry/azure/schemaregistry/aio/_schema_registry_client_async.py

@@ -182,10 +182,10 @@ async def get_schema_properties(
         as matched by schema defintion comparison.
 
         :param str group_name: Schema group under which schema should be registered.
-        :param str name: Name of schema being registered.
-        :param str definition: String representation of the schema being registered.
-        :param format: Format for the schema being registered.
-        :type format: Union[str, ~azure.schemaregistry.SchemaFormat]
+        :param str name: Name of schema for which properties should be retrieved.
+        :param str definition: String representation of the schema for which properties should be retrieved.
+        :param format: Format for the schema for which properties should be retrieved.
+        :type format: Union[str, SchemaFormat]
         :rtype: ~azure.schemaregistry.SchemaProperties
         :raises: :class:`~azure.core.exceptions.HttpResponseError`
 

sdk/schemaregistry/azure-schemaregistry/samples/sync_samples/schema_registry.py

@@ -80,7 +80,7 @@ def get_schema_by_id(client, schema_id):
     print("Getting schema by id...")
     schema = client.get_schema(schema_id)
     print(
-        "The schema string of schema id: {} string is {}".format(id, schema.definition)
+        "The schema string of schema id: {} string is {}".format(schema_id, schema.definition)
     )
     print("Schema properties are {}".format(schema_id))
     return schema.definition

sdk/schemaregistry/azure-schemaregistry/tests/async_tests/test_schema_registry_async.py

@@ -58,11 +58,15 @@ async def test_schema_basic_async(self, schemaregistry_fully_qualified_namespace
 
             assert returned_schema.properties.id == schema_properties.id
             assert returned_schema.properties.format == "Avro"
+            assert returned_schema.properties.group_name == schemaregistry_group
+            assert returned_schema.properties.name == name
             assert returned_schema.definition == schema_str
 
             returned_schema_properties = await client.get_schema_properties(schemaregistry_group, name, schema_str, format, logging_enable=True)
 
             assert returned_schema_properties.id == schema_properties.id
+            assert returned_schema.properties.group_name == schemaregistry_group
+            assert returned_schema.properties.name == name
             assert returned_schema_properties.format == "Avro"
         await client._generated_client._config.credential.close()
 
@@ -84,13 +88,17 @@ async def test_schema_update_async(self, schemaregistry_fully_qualified_namespac
 
             assert new_schema_properties.id is not None
             assert new_schema_properties.format == "Avro"
+            assert new_schema_properties.group_name == schemaregistry_group
+            assert new_schema_properties.name == name
 
             new_schema = await client.get_schema(schema_id=new_schema_properties.id)
 
             assert new_schema.properties.id != schema_properties.id
             assert new_schema.properties.id == new_schema_properties.id
             assert new_schema.definition == schema_str_new
             assert new_schema.properties.format == "Avro"
+            assert new_schema.properties.group_name == schemaregistry_group
+            assert new_schema.properties.name == name
 
         await client._generated_client._config.credential.close()
 

sdk/schemaregistry/azure-schemaregistry/tests/test_schema_registry.py

@@ -54,12 +54,16 @@ def test_schema_basic(self, **kwargs):
 
         assert returned_schema.properties.id == schema_properties.id
         assert returned_schema.properties.format == "Avro"
+        assert returned_schema.properties.group_name == schemaregistry_group
+        assert returned_schema.properties.name == name
         assert returned_schema.definition == schema_str
 
         returned_schema_properties = client.get_schema_properties(schemaregistry_group, name, schema_str, format, logging_enable=True)
 
         assert returned_schema_properties.id == schema_properties.id
         assert returned_schema_properties.format == "Avro"
+        assert returned_schema.properties.group_name == schemaregistry_group
+        assert returned_schema.properties.name == name
 
     @SchemaRegistryEnvironmentVariableLoader()
     @recorded_by_proxy
@@ -80,13 +84,17 @@ def test_schema_update(self, **kwargs):
 
         assert new_schema_properties.id is not None
         assert new_schema_properties.format == "Avro"
+        assert new_schema_properties.group_name == schemaregistry_group
+        assert new_schema_properties.name == name
 
         new_schema = client.get_schema(schema_id=new_schema_properties.id)
 
         assert new_schema.properties.id != schema_properties.id
         assert new_schema.properties.id == new_schema_properties.id
         assert new_schema.definition == schema_str_new
         assert new_schema.properties.format == "Avro"
+        assert new_schema.properties.group_name == schemaregistry_group
+        assert new_schema.properties.name == name
 
     @SchemaRegistryEnvironmentVariableLoader()
     @recorded_by_proxy