[Azure Maps] Restore operationId for documentation (#16742)

* Fix Weather IconCode enum * Restore operationId prefixes: first pass * Align the operationIds with Swaggers under Microsoft.Map * Rename GetPolygon method * Fix countryCode required attribute
Azure · Nov 12, 2021 · fabcb3e · fabcb3e
1 parent 18479a0
commit fabcb3e
Show file tree

Hide file tree

Showing 9 changed files with 146 additions and 86 deletions.
diff --git a/specification/maps/data-plane/DEM/preview/1.0/elevation.json b/specification/maps/data-plane/DEM/preview/1.0/elevation.json
@@ -57,7 +57,7 @@
       "get": {
         "summary": "Get Elevation Data on One or More Points",
         "description": "**Applies to**: S1 pricing tier.\n\n The Get Data for Points API provides elevation data for one or more points.  A point is defined in lat,long coordinate format.\n\n Due to the URL character  length limit of 2048, it's not possible to pass more than 100 coordinates  as a pipeline delimited string in a URL GET request. If you intend to pass  more than 100 coordinates as a pipeline delimited string, use the [POST Data\n For Points](https://docs.microsoft.com/rest/api/maps/elevation/postdataforpoints).\n\n The result will be in the same sequence of points listed in the request.",
-        "operationId": "GetDataForPoints",
+        "operationId": "Elevation_GetDataForPoints",
         "x-ms-examples": {
           "Successfully retrieve elevation data for one or more points using get": {
             "$ref": "./examples/GetDataForPoints.json"
@@ -102,7 +102,7 @@
       "post": {
         "summary": "Query Elevation Data for Multiple Points",
         "description": "**Applies to**: S1 pricing tier.\n\n The Post Data for Points API provides elevation data for multiple points.  A point is defined lon/lat coordinate format.\n\n Use the POST endpoint only if you intend to pass multiple points in the request. If you intend to pass  a single coordinate into the API, use the [GET Data For Points API](https://docs.microsoft.com/rest/api/maps/elevation/getdataforpoints).\n\n The result will be in the same sequence of points listed in the request.",
-        "operationId": "PostDataForPoints",
+        "operationId": "Elevation_PostDataForPoints",
         "x-ms-examples": {
           "Successfully retrieve elevation data for multiple points using post": {
             "$ref": "./examples/PostDataForPoints.json"
@@ -145,7 +145,7 @@
       "get": {
         "summary": "Get Elevation Data Along a Polyline",
         "description": "**Applies to**: S1 pricing tier.\n\n The Get Data for Polyline API provides elevation data along a polyline.\n\n A polyline is defined by passing in between 2 and N endpoint coordinates separated by a pipe ('|') character. In addition to passing in endpoints, customers can specify the number of sample points that will be used to divide polyline into equally spaced segments.\n\n Elevation data at both start and endpoints, as well as equally spaced points along the polyline will be returned. The results will be listed in the direction from the first endpoint towards the last endpoint. A line between two endpoints is a straight Cartesian line, the  shortest line between those two points in the coordinate reference system. Note that the point is  chosen based on Euclidean distance and may markedly differ from the geodesic path along the curved  surface of the reference ellipsoid.",
-        "operationId": "GetDataForPolyline",
+        "operationId": "Elevation_GetDataForPolyline",
         "x-ms-examples": {
           "Successfully retrieve elevation data along a polyline using get": {
             "$ref": "./examples/GetDataForPolyline.json"
@@ -198,7 +198,7 @@
       "post": {
         "summary": "Query Elevation Data Along a Polyline",
         "description": "**Applies to**: S1 pricing tier.\n\n The Post Data for Polyline API provides elevation data along a polyline.\n\n A polyline is defined by  passing in between 2 and N endpoint coordinates separated by a pipe ('|') character. In addition  to passing in endpoints, customers can specify the number of sample points that will be used to divide polyline into equally spaced segments.\n\n Elevation data at both start and end points, as well as equally spaced  points along the polyline will be returned. The results will be listed in the direction from the first endpoint towards the last endpoint. A line between two endpoints is a straight Cartesian line, the  shortest line between those two points in the coordinate reference system. Note that the point is  chosen based on Euclidean distance and may markedly differ from the geodesic path along the curved surface of the reference ellipsoid.",
-        "operationId": "PostDataForPolyline",
+        "operationId": "Elevation_PostDataForPolyline",
         "x-ms-examples": {
           "Successfully retrieve elevation data along a polyline using post": {
             "$ref": "./examples/PostDataForPolyline.json"
@@ -249,7 +249,7 @@
       "get": {
         "summary": "Get Elevation Data at Equally Spaced Locations Within a Bounding Box",
         "description": "**Applies to**: S1 pricing tier.\n\nThe Get Data for Bounding Box API provides elevation data at equally spaced locations within a bounding box. A bounding box is defined by the coordinates for two corners (southwest, northeast) and then subsequently  divided into rows and columns.\n\n Elevations are returned for the vertices of the grid created by the rows and  columns. Up to 2,000 elevations can be returned in a single request. The returned elevation values are ordered,  starting at the southwest corner, and then proceeding west to east along the row. At the end of the row,  it moves north to the next row, and repeats the process until it reaches the far northeast corner.",
-        "operationId": "GetDataForBoundingBox",
+        "operationId": "Elevation_GetDataForBoundingBox",
         "x-ms-examples": {
           "Successfully retrieve elevation data within a bounding box": {
             "$ref": "./examples/GetDataForBoundingBox.json"

diff --git a/specification/maps/data-plane/Geolocation/preview/1.0/geolocation.json b/specification/maps/data-plane/Geolocation/preview/1.0/geolocation.json
@@ -56,7 +56,8 @@
     "/geolocation/ip/{format}": {
       "get": {
         "description": "\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis service will return the ISO country code for the provided IP address. Developers can use this information  to block or alter certain content based on geographical locations where the application is being viewed from.",
-        "operationId": "GetLocation",
+        "operationId": "Geolocation_GetIPToLocation",
+        "x-ms-client-name": "GetLocation",
         "x-ms-examples": {
           "Successfully retrieve country code from IP address": {
             "$ref": "./examples/SuccessfulGetCountryCodeFromIP.json"

diff --git a/specification/maps/data-plane/Render/preview/1.0/render.json b/specification/maps/data-plane/Render/preview/1.0/render.json
@@ -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": "GetMapStaticImage",
+        "operationId": "Render_GetMapImage",
+        "x-ms-client_name": "GetMapStaticImage",
         "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": "GetMapTile",
+        "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": "GetMapStateTile",
+        "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": "GetCopyrightCaption",
+        "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": "GetMapImageryTile",
+        "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": "GetCopyrightFromBoundingBox",
+        "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": "GetCopyrightForTile",
+        "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": "GetCopyrightForWorld",
+        "operationId": "Render_GetCopyrightForWorld",
         "x-ms-examples": {
           "Successful World Copyright Request": {
             "$ref": "./examples/SuccessfulWorldCopyrightRequest.json"

diff --git a/specification/maps/data-plane/Render/preview/2.0/render.json b/specification/maps/data-plane/Render/preview/2.0/render.json
@@ -192,7 +192,7 @@
     "/map/tile": {
       "get": {
         "description": "**Applies to**: S0 and S1 pricing tiers.\n\nThe Get Map Tiles API allows users to request map tiles in vector or raster formats typically to be integrated  into a map control or SDK. Some example tiles that can be requested are Azure Maps road tiles, real-time  Weather Radar tiles or the map tiles created using [Azure Maps Creator](https://aka.ms/amcreator). By default,  Azure Maps uses vector tiles for its web map control (Web SDK) and Android SDK.",
-        "operationId": "GetMapTileV2",
+        "operationId": "RenderV2_GetMapTile",
         "x-ms-examples": {
           "Successful Tile Request": {
             "$ref": "./examples/SuccessfulTileRequest.json"