Azure Maps DEM Post Deprecation Clean Up #24038
Conversation
ismael-ms
requested review from
vicancy and
johanste
and removed request for
a team
|
Hi, @ismael-ms Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| render.json | 2022-08-01(6df3839) | 2022-08-01(main) |
| Rule | Message |
|---|---|
|
The new version is removing enum value(s) 'microsoft.dem, microsoft.dem.contours' from the old version. Old: Render/stable/2022-08-01/render.json#L294:9 |
|
The new version is removing enum value(s) 'microsoft.dem, microsoft.dem.contours' from the old version. Old: Render/stable/2022-08-01/render.json#L368:9 |
|
The new version is removing enum value(s) 'microsoft.dem, microsoft.dem.contours' from the old version. Old: Render/stable/2022-08-01/render.json#L404:9 |
|
The new version is removing enum value(s) 'microsoft.dem, microsoft.dem.contours' from the old version. New: Render/stable/2022-08-01/render.json#L145:5 Old: Render/stable/2022-08-01/render.json#L145:5 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.2) | new version | base version |
|---|---|---|
| 2022-08-01 | 2022-08-01(6df3839) | 2022-08-01(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
'file' is not a known format. Location: Render/stable/2022-08-01/render.json#L331 |
|
'file' is not a known format. Location: Render/stable/2022-08-01/render.json#L482 |
|
'file' is not a known format. Location: Render/stable/2022-08-01/render.json#L692 |
|
The integer type does not have a format, please add it. Location: Render/stable/2022-08-01/render.json#L951 |
|
The integer type does not have a format, please add it. Location: Render/stable/2022-08-01/render.json#L958 |
| Error response should contain a x-ms-error-code header. Location: Render/stable/2022-08-01/render.json#L341 |
|
The error property in the error response schema should be required.Location: Render/stable/2022-08-01/render.json#L341 |
|
Error schema should define code and message properties as required.Location: Render/stable/2022-08-01/render.json#L341 |
|
| Schema with type: integer should specify format Location: Render/stable/2022-08-01/render.json#L373 |
|
| Schema with type: integer should specify format Location: Render/stable/2022-08-01/render.json#L373 |
|
| Error response should contain a x-ms-error-code header. Location: Render/stable/2022-08-01/render.json#L377 |
|
The error property in the error response schema should be required.Location: Render/stable/2022-08-01/render.json#L377 |
|
Error schema should define code and message properties as required.Location: Render/stable/2022-08-01/render.json#L377 |
|
| Based on the response model schema, operation 'Render_GetMapAttribution' might be pageable. Consider adding the x-ms-pageable extension. Location: Render/stable/2022-08-01/render.json#L384 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Render/stable/2022-08-01/render.json#L384 |
|
| Error response should contain a x-ms-error-code header. Location: Render/stable/2022-08-01/render.json#L434 |
|
The error property in the error response schema should be required.Location: Render/stable/2022-08-01/render.json#L434 |
|
Error schema should define code and message properties as required.Location: Render/stable/2022-08-01/render.json#L434 |
|
| Error response should contain a x-ms-error-code header. Location: Render/stable/2022-08-01/render.json#L492 |
|
The error property in the error response schema should be required.Location: Render/stable/2022-08-01/render.json#L492 |
|
Error schema should define code and message properties as required.Location: Render/stable/2022-08-01/render.json#L492 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Render/stable/2022-08-01/render.json#L514 |
|
| Error response should contain a x-ms-error-code header. Location: Render/stable/2022-08-01/render.json#L525 |
|
The error property in the error response schema should be required.Location: Render/stable/2022-08-01/render.json#L525 |
|
Error schema should define code and message properties as required.Location: Render/stable/2022-08-01/render.json#L525 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Render/stable/2022-08-01/render.json#L547 |
|
| Error response should contain a x-ms-error-code header. Location: Render/stable/2022-08-01/render.json#L702 |
|
The error property in the error response schema should be required.Location: Render/stable/2022-08-01/render.json#L702 |
|
Error schema should define code and message properties as required.Location: Render/stable/2022-08-01/render.json#L702 |
|
| Based on the response model schema, operation 'Render_GetCopyrightFromBoundingBox' might be pageable. Consider adding the x-ms-pageable extension. Location: Render/stable/2022-08-01/render.json#L709 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
Generated ApiView
|
ghost
added
the
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @ismael-ms, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
Hello @anuchandy, this should not be considered a breaking change as the information I'm removing pertains to a deprecation that has already taken place per Azure update here: https://azure.microsoft.com/en-us/updates/azure-maps-elevation-apis-and-render-v2-dem-tiles-will-be-retired-on-5-may-2023/. In this PR, I'm only removing the deprecation banner for the Render V2 - Get Map Tile - REST API (Azure Maps) | Microsoft Learn |
|
Hi @anuchandy, please let me know if there are any blockers in this PR or if it is okay to move forward with it. Thank you. |
|
Approving since the breaking change has been approved. |
anuchandy
added
the
Approved-BreakingChange
…4038) Merging. Notes - 1. The enum values in the API 2022-08-01 version are deprecated - approved by the Azure retirement team. 2. While the API version is stable, non of the SDKs are GA-ed; [all](https://learn.microsoft.com/en-us/azure/azure-maps/rest-sdk-developer-guide) are shipped only in preview mode.
Data Plane API - Pull Request
The DEM tiles (tilesets with ID microsoft.dem and microsoft.dem.contours) were deprecated on 05/05/23. Now that some time has passed, the deprecation banner is no longer necessary, so I've removed them from the Render V2 APIs. I also removed references to the tilesets from the tilesetID list. This is not a breaking change as the tilesets have already gone through the deprecation cycle.
Previous related PRs:
#23290
#23307
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.
Is this review for (select one):
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.
❔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.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links