azure.analytics.purview.datamap

[yifan-zhou922]

Contributing to the Azure SDK

Please see our CONTRIBUTING.md if you are not familiar with contributing to this repository or have questions.

For specific information about pull request etiquette and best practices, see this section.

[azure-sdk]

API change check

APIView has identified API level changes in this PR and created following API reviews.

Azure.Analytics.Purview.DataMap

[yifan-zhou922]

Hi @chunyu3 , please help check the ci failures and provide some help on how to use recorded tests. Many thanks.

[archerzz]

By the way, there are some comments in the linked API view. Please resolve them as well.

[yifan-zhou922]

Thanks @archerzz for the comments. Also, as this is our first beta SDK release, model names might not be the blocker. These comments have been discussed before. Here is the full list: We have updated the SDK according to the comments. Below is a brief summary

• Rename AutoCompleteRequest/QueryRequest/xxxRequest to AutoCompleteOptions/QueryOptions/xxxOptions in Discovery APIs for SDK model
• Rename method name "bulk create or update" to "batch create or update"
• Rename the method name " xxx by unique attribute" to only "xxx by attribute"
• Rename the model name ContactBasic to ContactInfo
• Rename the model name SearchRequestTaxonomySetting to SearchTaxomonySetting
• Rename for type operations. Moving the "def" part to he operation grouping
  • For example, rename client.type.get_entity_def_by_guid to client.type_definition.get_entity_by_id
• Using "TypeCategory" for the enum model for query parameter "type" for GET /atlas/v2/types/typedefs?type={TypeCategory}
• Define "createTime"/"updateTime" as utcDateTime instead of merely int64 in SDK model
• Define search filter as object instead of adding a discriminator property called "kind"
• Fix all the casing problems for enum names
• Avoid using list operation in client method names. Rename list.xxx to merely get.xxx as list operation indicates the response will be a pageable result.
• Instead of defining many top level clients in SDK, we group them into operation groups (entity/discovery/glossary/lineage/type/relationship) into only one clients.
• Other renaming for path parameters/etc.

Below are the changes that we prefer not to update.

• For Atlas model naming like AtlasEntitiesWithExtInfo/AtlasAttributeDef/etc, we want to keep them compatible with Atlas model. In the future, when atlas update the model version, we might also need to update accordingly.
• For suggestions to rename method businessMetadata to metadata and xxxbyUniqueAttribute to xxxbyAttribute, we want to keep the naming as businessMetadata and uniqueAttribute as they are the key concepts in Atlas and our api scenario.
• For LastModifiedTS, we want to keep it as int to provide a temporal order among a set of events. Timestamping (computing) - Wikipedia

[chunyu3]

Hi @chunyu3 , please help check the ci failures and provide some help on how to use recorded tests. Many thanks.

Hello @yifan-zhou922 The ci failure because the environment variable is not provided. Make sure your recording contains needed environment variable.

System.InvalidOperationException : Unable to find environment variable PURVIEW_PURVIEW_ENDPOINT or PURVIEW_ENDPOINT required by test.
2024-03-04T13:56:59.1203241Z Make sure the test environment was initialized using the eng/common/TestResources/New-TestResources.ps1 script.

[yifan-zhou922]

All samples have been updated accroding to the TSG. azure-sdk-for-net/doc/DataPlaneCodeGeneration/Create_Samples_Guidance.md at main · Azure/azure-sdk-for-net (github.com) ，

[yifan-zhou922]

All comments resolved. Hi @catalinaperalta, please help approve & merge the PRs if there are no other comments.