Deprecate Maps Elevation API #23290
Merged
Deprecate Maps Elevation API #23290
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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 |
|---|---|---|
| elevation.json | 1.0(41517e0) | 1.0(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 |
|---|---|---|
| 1.0-preview | 1.0-preview(41517e0) | 1.0-preview(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The integer type does not have a format, please add it. Location: DEM/preview/1.0/elevation.json#L185 |
|
The integer type does not have a format, please add it. Location: DEM/preview/1.0/elevation.json#L234 |
|
The integer type does not have a format, please add it. Location: DEM/preview/1.0/elevation.json#L290 |
|
The integer type does not have a format, please add it. Location: DEM/preview/1.0/elevation.json#L299 |
| API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'. Location: DEM/preview/1.0/elevation.json#L5 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: DEM/preview/1.0/elevation.json#L66 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ElevationModel'. Consider using the plural form of 'Elevation' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: DEM/preview/1.0/elevation.json#L69 |
|
| A required parameter should not specify a default value. Location: DEM/preview/1.0/elevation.json#L79 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: DEM/preview/1.0/elevation.json#L82 |
|
| Error response should contain a x-ms-error-code header. Location: DEM/preview/1.0/elevation.json#L105 |
|
The error property in the error response schema should be required.Location: DEM/preview/1.0/elevation.json#L105 |
|
Error schema should define code and message properties as required.Location: DEM/preview/1.0/elevation.json#L105 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: DEM/preview/1.0/elevation.json#L110 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ElevationModel'. Consider using the plural form of 'Elevation' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: DEM/preview/1.0/elevation.json#L113 |
|
| A required parameter should not specify a default value. Location: DEM/preview/1.0/elevation.json#L123 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: DEM/preview/1.0/elevation.json#L126 |
|
| Error response should contain a x-ms-error-code header. Location: DEM/preview/1.0/elevation.json#L146 |
|
The error property in the error response schema should be required.Location: DEM/preview/1.0/elevation.json#L146 |
|
Error schema should define code and message properties as required.Location: DEM/preview/1.0/elevation.json#L146 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: DEM/preview/1.0/elevation.json#L153 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ElevationModel'. Consider using the plural form of 'Elevation' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: DEM/preview/1.0/elevation.json#L156 |
|
| A required parameter should not specify a default value. Location: DEM/preview/1.0/elevation.json#L166 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: DEM/preview/1.0/elevation.json#L169 |
|
| Error response should contain a x-ms-error-code header. Location: DEM/preview/1.0/elevation.json#L201 |
|
The error property in the error response schema should be required.Location: DEM/preview/1.0/elevation.json#L201 |
|
Error schema should define code and message properties as required.Location: DEM/preview/1.0/elevation.json#L201 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: DEM/preview/1.0/elevation.json#L206 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ElevationModel'. Consider using the plural form of 'Elevation' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: DEM/preview/1.0/elevation.json#L209 |
|
| A required parameter should not specify a default value. Location: DEM/preview/1.0/elevation.json#L219 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: DEM/preview/1.0/elevation.json#L222 |
️️✔️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: 0 Errors, 0 Warnings failed [Detail]
️️✔️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 Generation Artifacts
|
|
Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment. |
ghost
added
the
ismael-ms
force-pushed
the
ismael-ms-maps-DEM-1.0
branch
3 times, most recently
from
af64236 to
705b05a
Compare
ismael-ms
force-pushed
the
ismael-ms-maps-DEM-1.0
branch
2 times, most recently
from
cff2115 to
9d5d75c
Compare
ismael-ms
requested review from
JeffreyRichter and
MushMal
and removed request for
a team
ismael-ms
requested review from
mikekistler,
jhendrixMSFT,
markweitzel and
heaths
heaths
approved these changes
Mar 27, 2023
JoshLove-msft
pushed a commit
to JoshLove-msft/azure-rest-api-specs
that referenced
this pull request
Apr 25, 2023
* Add deprecation banner to Maps Elevation * Add hyperlink for retirement page
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
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):
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.
❔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