Skip to content

Commit 8388530

Browse files
committed
Update docs metadata
1 parent 934e597 commit 8388530

File tree

2 files changed

+17
-16
lines changed

2 files changed

+17
-16
lines changed

docs-ref-services/preview/schemaregistry-avroencoder-readme.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ title: Azure Schema Registry Avro Encoder client library for Python
33
keywords: Azure, python, SDK, API, azure-schemaregistry-avroencoder, schemaregistry
44
author: yunhaoling
55
ms.author: yuling
6-
ms.date: 03/09/2022
6+
ms.date: 04/05/2022
77
ms.topic: reference
88
ms.prod: azure
99
ms.technology: azure
1010
ms.devlang: python
1111
ms.service: schemaregistry
1212
---
13-
# Azure Schema Registry Avro Encoder client library for Python - Version 1.0.0b2
13+
# Azure Schema Registry Avro Encoder client library for Python - Version 1.0.0b3
1414

1515

1616
Azure Schema Registry is a schema repository service hosted by Azure Event Hubs, providing schema storage, versioning,
@@ -36,7 +36,7 @@ pip install azure-schemaregistry-avroencoder azure-identity
3636
### Prerequisites:
3737
To use this package, you must have:
3838
* Azure subscription - [Create a free account][azure_sub]
39-
* [Azure Schema Registry][schemaregistry_service]
39+
* [Azure Schema Registry][schemaregistry_service] - [Here is the quickstart guide][quickstart_guide] to create a Schema Registry group using the Azure portal.
4040
* Python 3.6 or later - [Install Python][python]
4141

4242
### Authenticate the client
@@ -83,7 +83,7 @@ content type with schema ID. Uses [SchemaRegistryClient][schemaregistry_client]
8383

8484
Support has been added to certain Azure Messaging SDK model classes for interoperability with the `AvroEncoder`. These models are subtypes of the `MessageType` protocol defined under the `azure.schemaregistry.encoder.avroencoder` namespace. Currently, the supported model classes are:
8585

86-
- `azure.eventhub.EventData` for `azure-eventhub==5.9.0b2`
86+
- `azure.eventhub.EventData` for `azure-eventhub==5.9.0b3`
8787

8888
### Message format
8989

@@ -99,7 +99,7 @@ If a message type that follows the MessageType protocol is provided to the encod
9999
- `avro/binary` is the format indicator
100100
- `<schema ID>` is the hexadecimal representation of GUID, same format and byte order as the string from the Schema Registry service.
101101

102-
If message type or callback function is not provided, and by default, the encoder will create the following dict:
102+
If message type is not provided, and by default, the encoder will create the following dict:
103103
`{"content": <Avro encoded payload>, "content_type": 'avro/binary+<schema ID>' }`
104104

105105
## Examples
@@ -114,7 +114,7 @@ The following sections provide several code snippets covering some of the most c
114114
### Encoding
115115

116116
Use `AvroEncoder.encode` method to encode dict content with the given Avro schema.
117-
The method will use a schema previously registered to the Schema Registry service and keep the schema cached for future encoding usage. It is also possible to avoid pre-registering the schema to the service and automatically register with the `encode` method by instantiating the `AvroEncoder` with the keyword argument `auto_register_schemas=True`.
117+
The method will use a schema previously registered to the Schema Registry service and keep the schema cached for future encoding usage. It is also possible to avoid pre-registering the schema to the service and automatically register with the `encode` method by instantiating the `AvroEncoder` with the keyword argument `auto_register=True`.
118118

119119
```python
120120
import os
@@ -215,7 +215,7 @@ definition = """
215215
}"""
216216

217217
schema_registry_client = SchemaRegistryClient(fully_qualified_namespace, token_credential)
218-
avro_encoder = AvroEncoder(client=schema_registry_client, group_name=group_name, auto_register_schemas=True)
218+
avro_encoder = AvroEncoder(client=schema_registry_client, group_name=group_name, auto_register=True)
219219

220220
eventhub_producer = EventHubProducerClient.from_connection_string(
221221
conn_str=eventhub_connection_str,
@@ -328,15 +328,16 @@ contact [[email protected]](mailto:[email protected]) with any additio
328328
[pip]: https://pypi.org/project/pip/
329329
[pypi]: https://pypi.org/project/azure-schemaregistry-avroencoder/
330330
[python]: https://www.python.org/downloads/
331-
[azure_core]: https://github.com/Azure/azure-sdk-for-python/blob/azure-schemaregistry-avroencoder_1.0.0b2/sdk/core/azure-core/README.md
331+
[azure_core]: https://github.com/Azure/azure-sdk-for-python/blob/azure-schemaregistry-avroencoder_1.0.0b3/sdk/core/azure-core/README.md
332332
[azure_sub]: https://azure.microsoft.com/free/
333333
[python_logging]: https://docs.python.org/3/library/logging.html
334-
[sr_avro_samples]: https://github.com/Azure/azure-sdk-for-python/tree/azure-schemaregistry-avroencoder_1.0.0b2/sdk/schemaregistry/azure-schemaregistry-avroencoder/samples
334+
[sr_avro_samples]: https://github.com/Azure/azure-sdk-for-python/tree/azure-schemaregistry-avroencoder_1.0.0b3/sdk/schemaregistry/azure-schemaregistry-avroencoder/samples
335335
[api_reference]: https://docs.microsoft.com/python/api/overview/azure/schemaregistry-avroencoder-readme
336-
[source_code]: https://github.com/Azure/azure-sdk-for-python/tree/azure-schemaregistry-avroencoder_1.0.0b2/sdk/schemaregistry/azure-schemaregistry-avroencoder
337-
[change_log]: https://github.com/Azure/azure-sdk-for-python/tree/azure-schemaregistry-avroencoder_1.0.0b2/sdk/schemaregistry/azure-schemaregistry-avroencoder/CHANGELOG.md
338-
[schemaregistry_client]: https://github.com/Azure/azure-sdk-for-python/tree/azure-schemaregistry-avroencoder_1.0.0b2/sdk/schemaregistry/azure-schemaregistry
336+
[source_code]: https://github.com/Azure/azure-sdk-for-python/tree/azure-schemaregistry-avroencoder_1.0.0b3/sdk/schemaregistry/azure-schemaregistry-avroencoder
337+
[change_log]: https://github.com/Azure/azure-sdk-for-python/tree/azure-schemaregistry-avroencoder_1.0.0b3/sdk/schemaregistry/azure-schemaregistry-avroencoder/CHANGELOG.md
338+
[schemaregistry_client]: https://github.com/Azure/azure-sdk-for-python/tree/azure-schemaregistry-avroencoder_1.0.0b3/sdk/schemaregistry/azure-schemaregistry
339339
[schemaregistry_service]: https://aka.ms/schemaregistry
340-
[eventhubs_repo]: https://github.com/Azure/azure-sdk-for-python/tree/azure-schemaregistry-avroencoder_1.0.0b2/sdk/eventhub/azure-eventhub
341-
[token_credential_interface]: https://github.com/Azure/azure-sdk-for-python/tree/azure-schemaregistry-avroencoder_1.0.0b2/sdk/core/azure-core/azure/core/credentials.py
340+
[eventhubs_repo]: https://github.com/Azure/azure-sdk-for-python/tree/azure-schemaregistry-avroencoder_1.0.0b3/sdk/eventhub/azure-eventhub
341+
[token_credential_interface]: https://github.com/Azure/azure-sdk-for-python/tree/azure-schemaregistry-avroencoder_1.0.0b3/sdk/core/azure-core/azure/core/credentials.py
342342
[pypi_azure_identity]: https://pypi.org/project/azure-identity/
343+
[quickstart_guide]: https://docs.microsoft.com/azure/event-hubs/create-schema-registry
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"Name": "azure-schemaregistry-avroencoder",
3-
"Version": "1.0.0b2",
3+
"Version": "1.0.0b3",
44
"DevVersion": null,
55
"DirectoryPath": "sdk/schemaregistry/azure-schemaregistry-avroencoder",
66
"ServiceDirectory": "schemaregistry",
@@ -10,5 +10,5 @@
1010
"SdkType": "client",
1111
"IsNewSdk": false,
1212
"ArtifactName": "azure-schemaregistry-avroencoder",
13-
"ReleaseStatus": "2022-03-09"
13+
"ReleaseStatus": "2022-04-05"
1414
}

0 commit comments

Comments
 (0)