[Schema Registry] full pass over docstring

[swathipil]

for sync/async SR + Avro

• Are all params documented?

• Is priority order reasonable

• Return vals + descriptions

• Exceptions/error modes documented?

• #types + in-docstring + inline types?

• ask for api approval: https://apiview.dev/Assemblies/Review/21d5a1c19a6845cf9549faf0e30db2e1

[rakshith91]

• Do we need to mention azure-identity here in the pip install line? Customers are free to not depend on identity if they have their own implementation of TokenCredential. (granted that's not the case in 97% cases) pip install azure-schemaregistry azure-identity
  in that case, maybe we can add a snippet like this instead: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/servicebus/azure-servicebus/README.md#create-client-using-the-azure-identity-library
• api_reference link must be an aka.ms link that we can switch to docs.microsoft.com
• Expand key concepts based on https://docs.microsoft.com/en-us/azure/event-hubs/schema-registry-overview
• samples must use DefaultAzureCredential - also include a text like this
• run black formatting for samples
• docstrings should document ivar types as :vartype

[swathipil]

• Please add a repr to model types, following:

  azure-sdk-for-python/sdk/eventgrid/azure-eventgrid/azure/eventgrid/_models.py

  Line 96 in acf2264

  def __repr__(self):

• Add dictmixin? https://azure.github.io/azure-sdk/python_design.html#model-types --> no
• update docstring in samples with file description, like here:

  azure-sdk-for-python/sdk/monitor/azure-monitor-query/samples/async_samples/sample_log_query_async.py

  Lines 4 to 17 in f2e508f

  	FILE: sample_logs_single_query_async.py
  	DESCRIPTION:
  	This sample demonstrates authenticating the LogsQueryClient and executing a single
  	Kusto query.
  	USAGE:
  	python sample_logs_single_query_async.py
  	Set the environment variables with your own values before running the sample:
  	1) LOGS_WORKSPACE_ID - The first (primary) workspace ID.
  	This example uses DefaultAzureCredential, which requests a token from Azure Active Directory.
  	For more information on DefaultAzureCredential, see https://docs.microsoft.com/python/api/overview/azure/identity-readme?view=azure-python#defaultazurecredential.
  	**Note** - Although this example uses pandas to print the response, it's optional and
  	isn't a required package for querying. Alternatively, native Python can be used as well.

• update samples readme azure identity to resemble: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/servicebus/azure-servicebus/samples#setup
• document raises error in client methods (response.raise_for_status)
• remove EH + Avro Serializer section in README of SRClient? since it will not be GA'd
• update snippets in docs (remove the ones for schema/schemaProperties - not providing value) + update format with "Avro" in snippets

[rakshith91]

DOCSTRINGS:

• is as a might be a type https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/schemaregistry/azure-schemaregistry/azure/schemaregistry/_schema_registry_client.py#L44

[yunhaoling]

https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/schemaregistry/azure-schemaregistry/azure/schemaregistry/_common/_schema.py#L33-L38

https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/schemaregistry/azure-schemaregistry/azure/schemaregistry/_common/_schema.py#L65-L68

my fault, those should be vartype instead of type, otherwise sphinx can't recognize the type of the ivar

    :ivar id: References specific schema in registry namespace.
    :vartype id: str