Add deprecation banner to GetMapTile and GetMapTileset

[ismael-ms]

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: Engagement record does not exist yet. However, the following APIs have been approved for deprecation as per notice here: https://azure.microsoft.com/en-us/updates/azure-maps-elevation-apis-and-render-v2-dem-tiles-will-be-retired-on-5-may-2023/

Elevation services
Elevation - REST API (Azure Maps) | Microsoft Learn
Elevation - Get Data For Bounding Box - REST API (Azure Maps) | Microsoft Learn
Elevation - Get Data For Points - REST API (Azure Maps) | Microsoft Learn
Elevation - Get Data For Polyline - REST API (Azure Maps) | Microsoft Learn
Elevation - Post Data For Points - REST API (Azure Maps) | Microsoft Learn
Elevation - Post Data For Polyline - REST API (Azure Maps) | Microsoft Learn

Render V2 DEM Tiles
Render V2 - Get Map Tile - REST API (Azure Maps) | Microsoft Learn
Render V2 - Get Map Tileset - REST API (Azure Maps) | Microsoft Learn

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 Open API document (swagger) if applicable, and the root paths that have been updated.}

• Design Document: N/A
• Previous Open API Doc: N/A
• Updated paths: specification/maps/data-plane/Render/stable/2022-08-01/render.json

❔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-workflow-bot]

Hi, @ismael-ms Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

[openapi-pipeline-app]

Swagger Validation Report

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

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
render.json	2022-08-01(a821505)	2022-08-01(main)

️️✔️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.0.0)	new version	base version
2022-08-01	2022-08-01(a821505)	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
❌ ValidFormats	'file' is not a known format. Location: Render/stable/2022-08-01/render.json#L342
❌ ValidFormats	'file' is not a known format. Location: Render/stable/2022-08-01/render.json#L494
❌ ValidFormats	'file' is not a known format. Location: Render/stable/2022-08-01/render.json#L704
❌ IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Render/stable/2022-08-01/render.json#L963
❌ IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Render/stable/2022-08-01/render.json#L970
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: Render/stable/2022-08-01/render.json#L352
⚠️ ErrorResponse	The error property in the error response schema should be required. Location: Render/stable/2022-08-01/render.json#L352
⚠️ ErrorResponse	Error schema should define code and message properties as required. Location: Render/stable/2022-08-01/render.json#L352
⚠️ SchemaTypeAndFormat	Schema with type: integer should specify format Location: Render/stable/2022-08-01/render.json#L385
⚠️ SchemaTypeAndFormat	Schema with type: integer should specify format Location: Render/stable/2022-08-01/render.json#L385
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: Render/stable/2022-08-01/render.json#L389
⚠️ ErrorResponse	The error property in the error response schema should be required. Location: Render/stable/2022-08-01/render.json#L389
⚠️ ErrorResponse	Error schema should define code and message properties as required. Location: Render/stable/2022-08-01/render.json#L389
⚠️ PageableOperation	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#L396
⚠️ PaginationResponse	Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Render/stable/2022-08-01/render.json#L396
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: Render/stable/2022-08-01/render.json#L446
⚠️ ErrorResponse	The error property in the error response schema should be required. Location: Render/stable/2022-08-01/render.json#L446
⚠️ ErrorResponse	Error schema should define code and message properties as required. Location: Render/stable/2022-08-01/render.json#L446
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: Render/stable/2022-08-01/render.json#L504
⚠️ ErrorResponse	The error property in the error response schema should be required. Location: Render/stable/2022-08-01/render.json#L504
⚠️ ErrorResponse	Error schema should define code and message properties as required. Location: Render/stable/2022-08-01/render.json#L504
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Render/stable/2022-08-01/render.json#L526
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: Render/stable/2022-08-01/render.json#L537
⚠️ ErrorResponse	The error property in the error response schema should be required. Location: Render/stable/2022-08-01/render.json#L537
⚠️ ErrorResponse	Error schema should define code and message properties as required. Location: Render/stable/2022-08-01/render.json#L537
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Render/stable/2022-08-01/render.json#L559
⚠️ ErrorResponse	Error response should contain a x-ms-error-code header. Location: Render/stable/2022-08-01/render.json#L714
⚠️ ErrorResponse	The error property in the error response schema should be required. Location: Render/stable/2022-08-01/render.json#L714
⚠️ ErrorResponse	Error schema should define code and message properties as required. Location: Render/stable/2022-08-01/render.json#L714
⚠️ PageableOperation	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#L721

️️✔️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.

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

[openapi-pipeline-app]

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

[openapi-pipeline-app]

Generated ApiView

Language	Package Name	ApiView Link
Swagger	maps-data-plane-Render	https://apiview.dev/Assemblies/Review/20f7f44978b441d5be1c1a6b1375d3b9