azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Published
20 hours ago •
Azure
Azure
Upstream/release purview azure.analytics.purview.catalog 2022 08 01 preview
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 engagement record.
- Link to engagement record issue:
Is this review for (select one):
- [ ] a private preview
- [x] 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 Open API document (swagger) if applicable, and the root paths that have been updated.
- Design Document:
- Previous Open API Doc: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2022-03-01-preview/purviewcatalog.json
- Updated paths: Delete /glossary/terms Get /glossary/terms/bulkDeletion/{operationGuid}
❔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
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
Helpful Links
Hi, @yifan-zhou922 Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 96 Warnings warning [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| purviewcatalog.json | 2022-08-01-preview(3953550) | 2022-03-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 53 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2022-08 | package-preview-2022-08(3953550) | 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.
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The host parameter must be called 'endpoint'. Location: Azure.Analytics.Purview.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L12 |
|
The host parameter must be typed 'type 'string', format 'url''. Location: Azure.Analytics.Purview.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L12 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Entity' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L298 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Entity' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L604 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Azure.Analytics.Purview.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L968 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Azure.Analytics.Purview.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L1020 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Azure.Analytics.Purview.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L1069 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Azure.Analytics.Purview.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L1118 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Glossary' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L1553 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Glossary' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L1592 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Glossary' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L1639 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Glossary' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L1678 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Glossary' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L1709 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Glossary' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L1749 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Glossary' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L1779 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Azure.Analytics.Purview.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L1845 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Glossary' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L1917 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Glossary' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L1962 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Glossary' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L2011 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Glossary' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L2054 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Glossary' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L2084 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Glossary' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L2130 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Azure.Analytics.Purview.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L2375 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Glossary' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L2401 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Glossary' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L2432 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Glossary' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L2475 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Glossary' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L2505 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Glossary' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L2551 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Glossary' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L2597 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Glossary' should not appear after the underscore. 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.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L2633 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 0 Errors, 0 Warnings failed [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
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]
- Only show 18 items here, please refer to log for details.
❌Failed [Logs]Release - Generate from df54c612a18e376b1bc2ddb7dc12cb31d2a1c149. SDK Automation 14.0.0cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m 672 | [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:760 cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m 760 | [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:672 cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m 672 | [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.Share [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]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| swagger | purview-data-plane-Azure.Analytics.Purview.Catalog | https://apiview.dev/Assemblies/Review/315c320aeaca4affb22be502181a631d |
Hi @yifan-zhou922, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic validation | Fix-SemanticValidation-Error | High |
| Model validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | high |
Hi, @yifan-zhou922, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline
@yifan-zhou922 , the ModelValidation errors are all about the type mismatch. when the property is annotated as https://github.com/Azure/azure-rest-api-specs/blob/a9e13fe529181bd92099beaffbd9d20a9b6409ee/specification/purview/data-plane/Azure.Analytics.Purview.Catalog/preview/2022-08-01-preview/purviewcatalog.json#L6613 , it means the value of each element in the map should be object type. It cannot be a string or primitive types.
Recommendations for updating async error schema and url path for bulk delete glossary terms have been deployed to Production.
Hi @mikekistler / @markweitzel , could you please help review and signoff the changes? We have updated the PR according to the comments in the review meeting. Many thanks.
