[Hub Generated] Review request for Render to add version preview/2.1 (#…

…15411) * render updates based on #14625 * GetAttribution response codes * remove common error responses * go multiapi batch should include 2.0 * fix openapi 3.0 definition of file response, keep content-type * keep operationId between 2.0 and 2.1 * update samples and header response * exclude 2.0 from 2.1-preview tag, refs in 2.1 params, remove used Text param * refrain from changing 2.0 timestamp format * remove default in tileSize * remove redundant required: false * bump python package version * make sure there is no cross-client parameter references - move all shared into Common * remove non-supported application/xml MIME * use local apiversion param def
Azure · Aug 6, 2021 · 4d61f90 · 4d61f90
1 parent 633cc8d
commit 4d61f90
Show file tree

Hide file tree

Showing 11 changed files with 491 additions and 43 deletions.
diff --git a/specification/maps/data-plane/Common/preview/1.0/common.json b/specification/maps/data-plane/Common/preview/1.0/common.json
@@ -540,6 +540,13 @@
       "in": "header",
       "x-ms-parameter-location": "client"
     },
+    "Language": {
+      "name": "language",
+      "in": "query",
+      "description": "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details.",
+      "type": "string",
+      "x-ms-parameter-location": "method"
+    },
     "ResponseFormat": {
       "name": "format",
       "description": "Desired format of the response. Only `json` format is supported.",
@@ -613,6 +620,33 @@
         ]
       },
       "x-ms-parameter-location": "client"
+    },
+    "View": {
+      "name": "view",
+      "in": "query",
+      "description": "The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including  borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the  correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in  the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly  for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP  address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those  regarding mapping, of the country where maps, images and other data and third party content that you are authorized to  access via Azure Maps is made available. Example: view=IN.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views.",
+      "type": "string",
+      "x-ms-parameter-location": "method"
+    },
+    "xTileIndex": {
+      "name": "x",
+      "x-ms-client-name": "xTileIndex",
+      "in": "query",
+      "description": "X coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.",
+      "required": true,
+      "type": "integer",
+      "format": "int32",
+      "x-ms-parameter-location": "method"
+    },
+    "yTileIndex": {
+      "name": "y",
+      "x-ms-client-name": "yTileIndex",
+      "in": "query",
+      "description": "Y coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.",
+      "required": true,
+      "type": "integer",
+      "format": "int32",
+      "x-ms-parameter-location": "method"
     }
   },
   "responses": {

diff --git a/specification/maps/data-plane/Render/preview/1.0/render.json b/specification/maps/data-plane/Render/preview/1.0/render.json
@@ -105,26 +105,6 @@
       },
       "x-ms-parameter-location": "method"
     },
-    "xTileIndex": {
-      "name": "x",
-      "x-ms-client-name": "xTileIndex",
-      "in": "query",
-      "description": "X coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.",
-      "required": true,
-      "type": "integer",
-      "format": "int32",
-      "x-ms-parameter-location": "method"
-    },
-    "yTileIndex": {
-      "name": "y",
-      "x-ms-client-name": "yTileIndex",
-      "in": "query",
-      "description": "Y coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.",
-      "required": true,
-      "type": "integer",
-      "format": "int32",
-      "x-ms-parameter-location": "method"
-    },
     "RasterZoom18": {
       "name": "zoom",
       "in": "query",
@@ -300,10 +280,10 @@
             "maximum": 8192
           },
           {
-            "$ref": "../../../Search/preview/1.0/search.json#/parameters/Language"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/Language"
           },
           {
-            "$ref": "../../../Search/preview/1.0/search.json#/parameters/View"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/View"
           },
           {
             "name": "pins",
@@ -442,10 +422,10 @@
             "$ref": "#/parameters/RasterVectorNaturalEarthZoom"
           },
           {
-            "$ref": "#/parameters/xTileIndex"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/xTileIndex"
           },
           {
-            "$ref": "#/parameters/yTileIndex"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/yTileIndex"
           },
           {
             "name": "tileSize",
@@ -472,10 +452,10 @@
             }
           },
           {
-            "$ref": "../../../Search/preview/1.0/search.json#/parameters/Language"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/Language"
           },
           {
-            "$ref": "../../../Search/preview/1.0/search.json#/parameters/View"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/View"
           }
         ],
         "produces": [
@@ -526,10 +506,10 @@
             "$ref": "#/parameters/VectorZoom"
           },
           {
-            "$ref": "#/parameters/xTileIndex"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/xTileIndex"
           },
           {
-            "$ref": "#/parameters/yTileIndex"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/yTileIndex"
           },
           {
             "name": "statesetId",
@@ -640,10 +620,10 @@
             "$ref": "#/parameters/ImageryRasterZoom"
           },
           {
-            "$ref": "#/parameters/xTileIndex"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/xTileIndex"
           },
           {
-            "$ref": "#/parameters/yTileIndex"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/yTileIndex"
           }
         ],
         "produces": [
@@ -745,10 +725,10 @@
             "$ref": "#/parameters/RasterZoom18"
           },
           {
-            "$ref": "#/parameters/xTileIndex"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/xTileIndex"
           },
           {
-            "$ref": "#/parameters/yTileIndex"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/yTileIndex"
           },
           {
             "$ref": "#/parameters/IncludeText"

diff --git a/specification/maps/data-plane/Render/preview/2.0/render.json b/specification/maps/data-plane/Render/preview/2.0/render.json
@@ -76,7 +76,8 @@
         "microsoft.imagery",
         "microsoft.weather.radar.main",
         "microsoft.weather.infrared.main",
-        "microsoft.dem"
+        "microsoft.dem",
+        "microsoft.dem.contours"
       ],
       "x-ms-enum": {
         "name": "TilesetID",
@@ -129,6 +130,10 @@
           {
             "value": "microsoft.dem",
             "description": "Digital Elevation Model tiles. The tiles are in the GeoTIFF format with a single 32-bit floating point band. The tiles cover the whole landmass of Earth. Some small islands (e.g., atolls) might not be represented accurately.<br>\n* The vertical unit for measurement of elevation height is meters. An elevation value of -32767.0 is used for points that have no data value, most often returned where there isn't landmass (i.e. water).<br>\n* The horizontal reference datum is the World Geodetic System 1984 (WGS84-G1150) and the vertical reference datum is the Earth Gravitational Model 2008 (EGM2008).<br>\n* Tiles are 258x258 pixel squares rather than the standard 256 x 256. This is done to allow for accurate interpolation of values at the tile edges. As such adjacent tiles overlap by 1 pixel along all edges.<br>\n* Tile data comes from the [Airbus WorldDEM4Ortho product](https://www.intelligence-airbusds.com/worlddem-streaming/). Urban areas are approximately leveled down to ground level. All other areas are represented by the object surface level (e.g., trees). <br>\n\nSupports zoom level 13 only. Format: raster (tiff)."
+          },
+          {
+            "value": "microsoft.dem.contours",
+            "description": "Digital elevation contour line tiles. Compared to the microsoft.dem option, these tiles are in vector format and intended for visualization purpose. The tiles cover the whole landmass of Earth. Some small islands (e.g., atolls) might not be represented accurately.<br>\n* The vertical unit for measurement of elevation height is meters.<br>\n* The horizontal reference datum is the World Geodetic System 1984 (WGS84-G1150) and the vertical reference datum is the Earth Gravitational Model 2008 (EGM2008).<br>\n* Tile data comes from the [Airbus WorldDEM4Ortho product](https://www.intelligence-airbusds.com/worlddem-streaming/). Urban areas are approximately leveled down to ground level. All other areas are represented by the object surface level (e.g., trees).<br>\n\nSupports zoom levels 9 through 14. Format: vector (pbf)."
           }
         ]
       },
@@ -168,10 +173,10 @@
             "$ref": "#/parameters/MapTileV2Zoom"
           },
           {
-            "$ref": "../1.0/render.json#/parameters/xTileIndex"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/xTileIndex"
           },
           {
-            "$ref": "../1.0/render.json#/parameters/yTileIndex"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/yTileIndex"
           },
           {
             "name": "timeStamp",
@@ -205,10 +210,10 @@
             }
           },
           {
-            "$ref": "../../../Search/preview/1.0/search.json#/parameters/Language"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/Language"
           },
           {
-            "$ref": "../../../Search/preview/1.0/search.json#/parameters/View"
+            "$ref": "../../../Common/preview/1.0/common.json#/parameters/View"
           }
         ],
         "produces": [

diff --git a/specification/maps/data-plane/Render/preview/2.1/examples/GetMapAttributionV2.json b/specification/maps/data-plane/Render/preview/2.1/examples/GetMapAttributionV2.json
@@ -0,0 +1,18 @@
+{
+  "parameters": {
+    "api-version": "2.1",
+    "tilesetId": "microsoft.base",
+    "zoom": 6,
+    "bounds": "-122.414162,47.579490,-122.247157,47.668372"
+  },
+  "responses": {
+    "200": {
+      "headers": {},
+      "body": {
+        "copyrights": [
+          "<a>&copy; 2021 TomTom</a>"
+        ]
+      }
+    }
+  }
+}
diff --git a/specification/maps/data-plane/Render/preview/2.1/examples/GetMapTileV2.json b/specification/maps/data-plane/Render/preview/2.1/examples/GetMapTileV2.json
@@ -0,0 +1,17 @@
+{
+  "parameters": {
+    "api-version": "2.1",
+    "tilesetId": "microsoft.base",
+    "zoom": 6,
+    "x": 10,
+    "y": 22
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Content-Type": "application/vnd.mapbox-vector-tile"
+      },
+      "body": "{file}"
+    }
+  }
+}
diff --git a/specification/maps/data-plane/Render/preview/2.1/examples/GetMapTilesetV2.json b/specification/maps/data-plane/Render/preview/2.1/examples/GetMapTilesetV2.json
@@ -0,0 +1,28 @@
+{
+  "parameters": {
+    "api-version": "2.1",
+    "tilesetId": "microsoft.base"
+  },
+  "responses": {
+    "200": {
+      "headers": {},
+      "body": {
+        "tilejson": "2.2.0",
+        "version": "1.0.0",
+        "attribution": "<a>&copy; 2021 TomTom</a>",
+        "scheme": "xyz",
+        "tiles": [
+          "https://atlas.microsoft.com/map/tile?api-version=2.0&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}"
+        ],
+        "minzoom": 0,
+        "maxzoom": 22,
+        "bounds": [
+          -180,
+          -90,
+          180,
+          90
+        ]
+      }
+    }
+  }
+}