azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Published
20 hours ago •
Azure
Azure
Navigate API public 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 API Spec engagement record.
- Link to API Spec 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 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
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
Checks stuck in `queued` state?
If the PR CI checks appear to be stuck in `queued` state, please add a comment with contents `/azp run`. This should result in a new comment denoting a `PR validation pipeline` has started and the checks should be updated after few minutes.
Next Steps to Merge
✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?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): 575 Warnings warning [Detail]
| Compared specs (v0.10.8) | new version | base version |
|---|---|---|
| purviewdatamap.json | 2024-03-01-preview(6359f9b) | 2023-09-01(main) |
| purviewdatamap.json | 2024-03-01-preview(6359f9b) | 2023-10-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: 0 Errors, 227 Warnings failed [Detail]
| Compared specs (v2.2.1) | new version | base version |
|---|---|---|
| package-preview-2024-03 | package-preview-2024-03(6359f9b) | 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] |
|---|---|---|
| :warning: SecurityDefinitionDescription | Security definition should have a description. Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L42 |
|
| :warning: VersionPolicy | 'api-version' should be a required parameter Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L58 |
|
| :warning: VersionPolicy | 'api-version' should be a required parameter Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L145 |
|
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L159 |
|
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L166 |
|
| :warning: VersionPolicy | 'api-version' should be a required parameter Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L198 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L382 |
|
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L389 |
|
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L396 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L500 |
|
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L507 |
|
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L514 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L546 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L592 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L626 |
|
| :warning: AdditionalPropertiesObject | additionalProperties with type object is a common error. Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L648 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L676 |
|
| :warning: AdditionalPropertiesObject | additionalProperties with type object is a common error. Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L690 |
|
| :warning: VersionPolicy | Version segment 'v2' in path violates Azure versioning policy. Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L715 |
|
| :warning: ParameterOrder | Path parameter 'guid' should appear before 'businessMetadataName'. Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L719 |
|
| :warning: VersionPolicy | Operation does not define an 'api-version' query parameter. Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L719 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L720 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L727 |
|
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L749 |
|
| :warning: ErrorResponse | Error response schema should contain an object property named error.Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L751 |
|
| :warning: DeleteInOperationName | 'DELETE' operation 'Entity_RemoveBusinessMetadataAttributes' 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/preview/2024-03-01-preview/purviewdatamap.json#L763 |
|
| :warning: OperationId | OperationId for delete method should contain 'Delete' Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L763 |
|
| :warning: ParameterOrder | Path parameter 'guid' should appear before 'businessMetadataName'. Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L765 |
|
| :warning: VersionPolicy | Operation does not define an 'api-version' query parameter. Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L765 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.Analytics.Purview.DataMap/preview/2024-03-01-preview/purviewdatamap.json#L766 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
️️✔️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.
️️✔️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]
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️❌ azure-sdk-for-net-track2 failed [Detail]
- Only showing 20 items here. Refer to log for details.
❌Failed in generating from 800d5290a73a151d20c1a7417930bc26bf54f633. SDK Automation 14.0.0cmderr [Invoke-GenerateAndBuildV2.ps1] 714 | GeneratePackage -projectFolder $projectFolder -sdkRootPath $s … cmderr [Invoke-GenerateAndBuildV2.ps1] | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] | Failed to generate sdk artifact cmderr [Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714 cmderr [Invoke-GenerateAndBuildV2.ps1] Line | cmderr [Invoke-GenerateAndBuildV2.ps1] 714 | GeneratePackage -projectFolder $projectFolder -sdkRootPath $s … cmderr [Invoke-GenerateAndBuildV2.ps1] | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] | Failed to generate sdk. exit code: False cmderr [Invoke-GenerateAndBuildV2.ps1] Get-ChildItem: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:807 cmderr [Invoke-GenerateAndBuildV2.ps1] Line | cmderr [Invoke-GenerateAndBuildV2.ps1] 807 | … rtifacts += Get-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s … cmderr [Invoke-GenerateAndBuildV2.ps1] | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] | Cannot find path cmderr [Invoke-GenerateAndBuildV2.ps1] | '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because cmderr [Invoke-GenerateAndBuildV2.ps1] | it does not exist. cmderr [Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714 cmderr [Invoke-GenerateAndBuildV2.ps1] Line | cmderr [Invoke-GenerateAndBuildV2.ps1] 714 | GeneratePackage -projectFolder $projectFolder -sdkRootPath $s … cmderr [Invoke-GenerateAndBuildV2.ps1] | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] | Failed to generate sdk artifact
❌Azure.Analytics.Purview.Account [Preview SDK Changes]info [Changelog]
❌Azure.Analytics.Purview.Administration [Preview SDK Changes]info [Changelog]
❌Azure.Analytics.Purview.Catalog [Preview SDK Changes]info [Changelog]
❌Azure.Analytics.Purview.Scanning [Preview SDK Changes]info [Changelog]
❌Azure.Analytics.Purview.Sharing [Preview SDK Changes]info [Changelog]
❌Azure.Analytics.Purview.Workflows [Preview SDK Changes]info [Changelog]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Swagger | Azure.Analytics.Purview.DataMap | https://apiview.dev/Assemblies/Review/17f9d062cae340bd9a831088c8b58219?revisionId=82c7733d82df4211985043b48e2d3e09 |
Preview Azure Board review meeting notes: https://github.com/Azure/azure-rest-api-specs/issues/26429
I am OK with the API.
But all those error in "Breaking Change(Cross-Version)" need to be approved separately. My recommendation is go with the typespec.
The LintDiff CI seems not working as expected. I've opened an issue for this https://github.com/Azure/azure-sdk-tools/issues/8165
Ignore the LintDiff, as error is about /sentShare which is not in this tsp/swagger.
https://github.com/Azure/azure-sdk-tools/issues/8165#issuecomment-2095259470