[Azure Maps] Restore operationId for documentation #16742
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -165,7 +165,8 @@ | |
| "/map/static/{format}": { | ||
| "get": { | ||
| "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nThe static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice. \n\nService also provides Image Composition functionality to get a static image back with additional data like; pushpins and geometry overlays with following S0 and S1 capabilities. \n\nIn S0 you can:\n- Render up to 5 pushpins specified in the request\n- Provide one custom image for the pins referenced in the request\n- Add labels to the pushpins\n\nIn S1 you can:\n- Render pushpins through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n- Specify multiple pushpin styles\n- Render circle, polyline and polygon geometry types.\n- Render of supported GeoJSON geometry types uploaded through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n\nPlease see [How-to-Guide](https://aka.ms/AzureMapsHowToGuideImageCompositor) for detailed examples.\n\n_Note_ : Either **center** or **bbox** parameter must be supplied to the\nAPI.\n<br><br>\nThe supported Lat and Lon ranges when using the **bbox** parameter, are as follows:\n<br><br>\n\n |Zoom Level | Max Lon Range | Max Lat Range|\n |:----------|:----------------|:-------------|\n |0 | 360.0 | 170.0 | \n |1 | 360.0 | 170.0 |\n |2 | 360.0 | 170.0 |\n |3 | 360.0 | 170.0 |\n |4 | 360.0 | 170.0 |\n |5 | 180.0 | 85.0 |\n |6 | 90.0 | 42.5 |\n |7 | 45.0 | 21.25 |\n |8 | 22.5 | 10.625 |\n |9 | 11.25 | 5.3125 |\n |10 | 5.625 | 2.62625 |\n |11 | 2.8125 | 1.328125 |\n |12 | 1.40625 | 0.6640625 |\n |13 | 0.703125 | 0.33203125 |\n |14 | 0.3515625 | 0.166015625 |\n |15 | 0.17578125 | 0.0830078125 | \n |16 | 0.087890625 | 0.0415039063 | \n |17 | 0.0439453125 | 0.0207519531 |\n |18 | 0.0219726563 | 0.0103759766 |\n |19 | 0.0109863281 | 0.0051879883 |\n |20 | 0.0054931641 | 0.0025939941 |", | ||
| "operationId": "Render_GetMapImage", | ||
| "x-ms-client_name": "GetMapStaticImage", | ||
|
Contributor
There was a problem hiding this comment. @tjprescott "x-ms-client_name" is an invalid name, you should use "x-ms-client-name" instead.
Member
Author
There was a problem hiding this comment. @kairu-ms @tjprescott Thanks for pointing this out. I've opened a PR to fix the typo: #17290 |
||
| "x-ms-examples": { | ||
| "Successful Static Image Request": { | ||
| "$ref": "./examples/SuccessfulStaticImageRequest.json" | ||
|
|
@@ -342,7 +343,7 @@ | |
| "/map/tile/{format}": { | ||
| "get": { | ||
| "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nFetches map tiles in vector or raster format typically to be integrated into a new map control or SDK. By default, Azure uses vector map tiles for its web map control (see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid))\n\n**Note**: Weather tiles are only available via [Get Map Tile V2 API](https://aka.ms/AzureMapsWeatherTiles). We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2).", | ||
| "operationId": "Render_GetMapTile", | ||
| "x-ms-examples": { | ||
| "Successful Tile Request": { | ||
| "$ref": "./examples/SuccessfulTileRequest.json" | ||
|
|
@@ -473,7 +474,7 @@ | |
| "/map/statetile": { | ||
| "get": { | ||
| "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nFetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling (see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid))", | ||
| "operationId": "Render_GetMapStateTile", | ||
| "x-ms-examples": { | ||
| "Successful State Tile Request": { | ||
| "$ref": "./examples/SuccessfulStateTileRequest.json" | ||
|
|
@@ -531,7 +532,7 @@ | |
| "/map/copyright/caption/{format}": { | ||
| "get": { | ||
| "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\n\nCopyrights API is designed to serve copyright information for Render Tile \nservice. In addition to basic copyright for the whole map, API is serving \nspecific groups of copyrights for some countries.\n\nAs an alternative to copyrights for map request, one can receive captions\nfor displaying the map provider information on the map.", | ||
| "operationId": "Render_GetCopyrightCaption", | ||
| "x-ms-examples": { | ||
| "Successful Copyright Caption Request": { | ||
| "$ref": "./examples/SuccessfulCopyrightCaptionRequest.json" | ||
|
|
@@ -564,7 +565,7 @@ | |
| "/map/imagery/{format}": { | ||
| "get": { | ||
| "description": "**Applies to:** S1 pricing tier.\n\n\nThis service returns a map image tile with size 256x256, given the x and y coordinates and zoom\nlevel. Zoom level ranges from 1 to 19. The current available style value is 'satellite' which provides satellite\nimagery alone.\n\n\n**Note**: We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2).", | ||
| "operationId": "Render_GetMapImageryTile", | ||
| "x-ms-examples": { | ||
| "Successful Imagery Tile Request": { | ||
| "$ref": "./examples/SuccessfulImageryTileRequest.json" | ||
|
|
@@ -640,7 +641,7 @@ | |
| "/map/copyright/bounding/{format}": { | ||
| "get": { | ||
| "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nReturns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates", | ||
| "operationId": "Render_GetCopyrightFromBoundingBox", | ||
| "x-ms-examples": { | ||
| "Successful Bounding Box Copyright Request": { | ||
| "$ref": "./examples/SuccessfulBoundingBoxCopyrightRequest.json" | ||
|
|
@@ -682,7 +683,7 @@ | |
| "/map/copyright/tile/{format}": { | ||
| "get": { | ||
| "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries.\nReturns the copyright information for a given tile. To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates (see: Zoom Levels and Tile Grid).", | ||
| "operationId": "Render_GetCopyrightForTile", | ||
| "x-ms-examples": { | ||
| "Successful Tile Copyright Request": { | ||
| "$ref": "./examples/SuccessfulTileCopyrightRequest.json" | ||
|
|
@@ -727,7 +728,7 @@ | |
| "/map/copyright/world/{format}": { | ||
| "get": { | ||
| "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries.\nReturns the copyright information for the world. To obtain the default copyright information for the whole world, do not specify a tile or bounding box.", | ||
| "operationId": "Render_GetCopyrightForWorld", | ||
| "x-ms-examples": { | ||
| "Successful World Copyright Request": { | ||
| "$ref": "./examples/SuccessfulWorldCopyrightRequest.json" | ||
|
|
||
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To verify, changing the operation ID like this would relocate these operations from the Client to a GeolocationOperations object. Does this x-ms-client-name preserve that?
I would expect this would generate
GeolocationOperations.get_location. Is that correct?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@tjprescott Yes, this
"x-ms-client-name": "GetLocation"will still preserve the GeolocationOperations object so the method signature matches what you expect.I've also tried passing
--inspectoroptions to the autorest, and found that it is the code model generated by the modelerfour that preserves the operationGroup.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks @alankashiwa
@tjprescott if there aren't any more concerns, can we please get this one merged? We'd like to start working on convenience layer next week. thanks!