[Hub Generated] Review request for Azure.Analytics.Purview.Catalog to add version stable/2023-09-01

[summerjune0730]

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

Data Plane API - Pull Request

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

• Link to API Spec engagement record issue:

Is this review for (select one):

• a private preview
• a public preview
• GA release

Change Scope

^{This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.}

• Design Document:
• Previous API Spec Doc:
• Updated paths:

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

• 💬 Teams Channel
• 💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

• Open API validation tools were run on this PR. Go here to see how to fix errors
• Spectral Linting
• Open API Hub

Guidelines & Specifications

• Azure REST API Guidelines
• OpenAPI Style Guidelines
• Azure Breaking Change Policy

Helpful Links

• Azure DevTools Wiki

[openapi-pipeline-app]

Next Steps to Merge

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

[openapi-pipeline-app]

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 633 Warnings warning [Detail]

compared tags (via openapi-validator v2.1.5)	new version	base version
package-2023-09	package-2023-09(e1fd5f3)	default(main)

[must fix]The following errors/warnings are introduced by current PR:

Only 30 items are listed, please refer to log for more details.

Rule	Message	Related RPC [For API reviewers]
⚠️ VersionPolicy	Version segment 'v2' in path violates Azure versioning policy. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L46
⚠️ PaginationResponse	Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L47
⚠️ SchemaTypeAndFormat	Schema with type: number should specify format Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L70
⚠️ SchemaTypeAndFormat	Schema with type: number should specify format Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L70
⚠️ VersionPolicy	'api-version' should be a required parameter Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L80
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L91
⚠️ ErrorResponse	Error response schema should contain an object property named error. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L93
⚠️ VersionPolicy	Version segment 'v2' in path violates Azure versioning policy. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L100
⚠️ PageableOperation	Based on the response model schema, operation 'Entity_ListByGuids' might be pageable. Consider adding the x-ms-pageable extension. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L101
⚠️ PaginationResponse	Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L101
⚠️ VersionPolicy	'api-version' should be a required parameter Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L131
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L142
⚠️ ErrorResponse	Error response schema should contain an object property named error. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L144
⚠️ PaginationResponse	Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L150
⚠️ VersionPolicy	'api-version' should be a required parameter Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L174
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L188
⚠️ ErrorResponse	Error response schema should contain an object property named error. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L190
⚠️ DeleteInOperationName	'DELETE' operation 'Entity_BulkDelete' should use method name 'Delete'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L201
⚠️ VersionPolicy	Operation does not define an 'api-version' query parameter. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L207
⚠️ Delete204Response	A delete operation should have a 204 response. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L221
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L228
⚠️ ErrorResponse	Error response schema should contain an object property named error. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L230
⚠️ VersionPolicy	Version segment 'v2' in path violates Azure versioning policy. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L237
⚠️ VersionPolicy	Operation does not define an 'api-version' query parameter. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L249
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L264
⚠️ ErrorResponse	Error response schema should contain an object property named error. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L266
⚠️ VersionPolicy	Version segment 'v2' in path violates Azure versioning policy. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L273
⚠️ VersionPolicy	Operation does not define an 'api-version' query parameter. Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L285
⚠️ PathParameterSchema	Path parameter maximum length should be less than 2083 Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L286
⚠️ SchemaTypeAndFormat	Schema with type: number should specify format Location: Azure.Analytics.Purview.DataMap/stable/2023-09-01/purviewdatamap.json#L299

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

️️✔️Automated merging requirements met succeeded [Detail] [Expand]

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app]

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account. 

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️❌ azure-sdk-for-net-track2 failed [Detail]

• ❌Failed [Logs]Release - Generate from ccae4a3. SDK Automation 14.0.0
  Only show 20 items here, please refer to log for details.
  

  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 714 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk. exit code: False
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGet-ChildItem: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:807
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 807 | �[0m … rtifacts += �[36;1mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s�[0m …
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mCannot find path
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1mit does not exist.
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 714 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk artifact
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m

• ❌Azure.Analytics.Purview.Account [View full logs]  [Release SDK Changes]

  info	[Changelog]

• ❌Azure.Analytics.Purview.Administration [View full logs]  [Release SDK Changes]

  info	[Changelog]

• ❌Azure.Analytics.Purview.Catalog [View full logs]  [Release SDK Changes]

  info	[Changelog]

• ❌Azure.Analytics.Purview.Scanning [View full logs]  [Release SDK Changes]

  info	[Changelog]

• ❌Azure.Analytics.Purview.Sharing [View full logs]  [Release SDK Changes]

  info	[Changelog]

• ❌Azure.Analytics.Purview.Workflows [View full logs]  [Release SDK Changes]

  info	[Changelog]

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app]

Generated ApiView

Language	Package Name	ApiView Link
Swagger	Azure.Analytics.Purview.DataMap	https://apiview.dev/Assemblies/Review/82a6152cf31f4775be63787a620b1f19

[yifan-zhou922]

/azp run unifiedPipeline

[azure-pipelines]

No pipelines are associated with this pull request.

[azure-pipelines]

No pipelines are associated with this pull request.

[mikekistler]

Looks good. 👍

[yifan-zhou922]

Hi @anuchandy , could you please help review and signoff the PR? Many thanks.

[weidongxu-microsoft]

I've only reviewed the non-/atlas/v2 APIs.

[weidongxu-microsoft]

Where is the "collectionId" of the entity? Is it in path or in entity property?

[summerjune0730]

It's in the path. We only allow the customer to specify one collectionid for all input entities.

[weidongxu-microsoft]

I am not sure about the purpose of this API. Is it a "List" or only the "{nextPage}" URL of another API?

[summerjune0730]

As the lineage info might contains too many entities, so this api is to get lineage with pagination support.

[weidongxu-microsoft]

I didn't see a PUT of /types/termtemplatedef/guid/{guid}. How's it created?

[summerjune0730]

all type defs are written by native Atlas API Post/Put /atlas/v2/types/typedefs

[summerjune0730]

/pr RequestMerge

[openapi-pipeline-app]

Swagger pipeline restarted successfully, please wait for status update in this comment.