From 0f9416f2c158145e336d9361802e2e387c4411c9 Mon Sep 17 00:00:00 2001 From: ambientlight Date: Thu, 29 Jul 2021 01:17:13 +0800 Subject: [PATCH 01/15] render updates based on https://github.com/Azure/azure-rest-api-specs/pull/14625 --- .../data-plane/Common/preview/1.0/common.json | 14 + .../preview/2.0/examples/GetMapTileV2.json | 45 ++ .../data-plane/Render/preview/2.0/render.json | 65 ++- .../2.1/examples/GetMapAttributionV2.json | 63 +++ .../preview/2.1/examples/GetMapTileV2.json | 60 ++ .../preview/2.1/examples/GetMapTilesetV2.json | 73 +++ .../data-plane/Render/preview/2.1/render.json | 512 ++++++++++++++++++ .../maps/data-plane/Render/readme.go.md | 11 +- .../maps/data-plane/Render/readme.md | 12 +- 9 files changed, 849 insertions(+), 6 deletions(-) create mode 100644 specification/maps/data-plane/Render/preview/2.1/examples/GetMapAttributionV2.json create mode 100644 specification/maps/data-plane/Render/preview/2.1/examples/GetMapTileV2.json create mode 100644 specification/maps/data-plane/Render/preview/2.1/examples/GetMapTilesetV2.json create mode 100644 specification/maps/data-plane/Render/preview/2.1/render.json diff --git a/specification/maps/data-plane/Common/preview/1.0/common.json b/specification/maps/data-plane/Common/preview/1.0/common.json index a50864ab973e..baaf6b454f95 100644 --- a/specification/maps/data-plane/Common/preview/1.0/common.json +++ b/specification/maps/data-plane/Common/preview/1.0/common.json @@ -539,6 +539,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.", @@ -612,6 +619,13 @@ ] }, "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" } }, "responses": { diff --git a/specification/maps/data-plane/Render/preview/2.0/examples/GetMapTileV2.json b/specification/maps/data-plane/Render/preview/2.0/examples/GetMapTileV2.json index 589af57c24fe..fe4c3d0aeefa 100644 --- a/specification/maps/data-plane/Render/preview/2.0/examples/GetMapTileV2.json +++ b/specification/maps/data-plane/Render/preview/2.0/examples/GetMapTileV2.json @@ -13,6 +13,51 @@ "Content-Type": "application/vnd.mapbox-vector-tile" }, "body": "{file}" + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } } } } diff --git a/specification/maps/data-plane/Render/preview/2.0/render.json b/specification/maps/data-plane/Render/preview/2.0/render.json index 234fba73e523..5a53bfdc567d 100644 --- a/specification/maps/data-plane/Render/preview/2.0/render.json +++ b/specification/maps/data-plane/Render/preview/2.0/render.json @@ -47,7 +47,44 @@ "AzureKey": [] } ], - "responses": {}, + "responses": { + "400": { + "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + }, + "401": { + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + }, + "headers": { + "WWW-Authenticate": { + "type": "string", + "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" + } + } + }, + "403": { + "description": "Permission, capacity, or authentication issues.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + }, + "404": { + "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + }, + "500": { + "description": "An error occurred while processing the request. Please try again later.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + }, "parameters": { "RenderApiVersionV2": { "name": "api-version", @@ -76,7 +113,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 +167,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.
\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).
\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).
\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.
\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).
\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.
\n* The vertical unit for measurement of elevation height is meters.
\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).
\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).
\n\nSupports zoom levels 9 through 14. Format: vector (pbf)." } ] }, @@ -204,10 +246,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": [ @@ -232,6 +274,21 @@ } } }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + }, "default": { "$ref": "../../../Common/preview/1.0/common.json#/responses/default" } 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 new file mode 100644 index 000000000000..c56fae2137ca --- /dev/null +++ b/specification/maps/data-plane/Render/preview/2.1/examples/GetMapAttributionV2.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2.1", + "tilesetId": "microsoft.base", + "zoom": 6, + "bounds": "-122.414162,47.579490,-122.247157,47.668372" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "copyrights": [ + "© 2021 TomTom" + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} 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 new file mode 100644 index 000000000000..ee2c24d32585 --- /dev/null +++ b/specification/maps/data-plane/Render/preview/2.1/examples/GetMapTileV2.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2.1", + "tilesetId": "microsoft.base", + "zoom": 6, + "x": 10, + "y": 22 + }, + "responses": { + "200": { + "headers": {}, + "body": "binary string image" + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} 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 new file mode 100644 index 000000000000..da367b6d38cd --- /dev/null +++ b/specification/maps/data-plane/Render/preview/2.1/examples/GetMapTilesetV2.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2.1", + "tilesetId": "microsoft.base" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "tilejson": "2.2.0", + "version": "1.0.0", + "attribution": "© 2021 TomTom", + "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 + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Render/preview/2.1/render.json b/specification/maps/data-plane/Render/preview/2.1/render.json new file mode 100644 index 000000000000..470b715b5883 --- /dev/null +++ b/specification/maps/data-plane/Render/preview/2.1/render.json @@ -0,0 +1,512 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Render Service", + "version": "2.1", + "description": "Azure Maps Render REST APIs" + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json", + "application/xml" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "AzureKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + } + ], + "responses": { + "400": { + "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + }, + "401": { + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + }, + "headers": { + "WWW-Authenticate": { + "type": "string", + "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" + } + } + }, + "403": { + "description": "Permission, capacity, or authentication issues.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + }, + "404": { + "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + }, + "500": { + "description": "An error occurred while processing the request. Please try again later.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": { + "RenderApiVersionV2": { + "name": "api-version", + "description": "Version number of Azure Maps API. Current version is 2.1", + "type": "string", + "in": "query", + "required": true, + "default": "2.1", + "x-ms-parameter-location": "client" + }, + "TilesetId_rv2": { + "name": "tilesetId", + "description": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/en-us/rest/api/maps/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "microsoft.base", + "microsoft.base.labels", + "microsoft.base.hybrid", + "microsoft.terra.main", + "microsoft.base.road", + "microsoft.base.darkgrey", + "microsoft.base.labels.road", + "microsoft.base.hybrid.road", + "microsoft.imagery", + "microsoft.weather.radar.main", + "microsoft.weather.infrared.main", + "microsoft.dem", + "microsoft.dem.contours" + ], + "x-ms-enum": { + "name": "TilesetID", + "modelAsString": true, + "values": [ + { + "value": "microsoft.base", + "description": "A base map is a standard map that displays roads, natural and artificial features along with the labels for those features in a vector tile.
\n\nSupports zoom levels 0 through 22. Format: vector (pbf)." + }, + { + "value": "microsoft.base.labels", + "description": "Displays labels for roads, natural and artificial features in a vector tile.
\n\nSupports zoom levels 0 through 22. Format: vector (pbf)." + }, + { + "value": "microsoft.base.hybrid", + "description": "Displays road, boundary and label data in a vector tile.
\n\nSupports zoom levels 0 through 22. Format: vector (pbf)." + }, + { + "value": "microsoft.terra.main", + "description": "Shaded relief and terra layers.
\n\nSupports zoom levels 0 through 6. Format: raster (png)." + }, + { + "value": "microsoft.base.road", + "description": "All layers with our main style.
\n\nSupports zoom levels 0 through 22. Format: raster (png)." + }, + { + "value": "microsoft.base.darkgrey", + "description": "All layers with our dark grey style.
\n\nSupports zoom levels 0 through 22. Format: raster (png)." + }, + { + "value": "microsoft.base.labels.road", + "description": "Label data in our main style.
\n\nSupports zoom levels 0 through 22. Format: raster (png)." + }, + { + "value": "microsoft.base.hybrid.road", + "description": "Road, boundary and label data in our main style.
\n\nSupports zoom levels 0 through 22. Format: raster (png)." + }, + { + "value": "microsoft.imagery", + "description": "A combination of satellite and aerial imagery. Only available in S1 pricing SKU.
\n\nSupports zoom levels 1 through 19. Format: raster (jpeg)." + }, + { + "value": "microsoft.weather.radar.main", + "description": "Weather radar tiles. Latest weather radar images including areas of rain, snow, ice and mixed conditions. Please see [coverage information](https://aka.ms/AzureMapsWeatherCoverage) for Azure Maps Weather service. To learn more about the Radar data, please see [Weather concepts](https://aka.ms/AzureMapsWeatherConcepts).
\n\nSupports zoom levels 0 through 15. Format: raster (png)." + }, + { + "value": "microsoft.weather.infrared.main", + "description": "Weather infrared tiles. Latest Infrared Satellite images shows clouds by their temperature. Please see [coverage information](https://aka.ms/AzureMapsWeatherCoverage) for Azure Maps Weather service. To learn more about the returned Satellite data, please see [Weather concepts](https://aka.ms/AzureMapsWeatherConcepts).
\n\nSupports zoom levels 0 through 15. Format: raster (png)." + }, + { + "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.
\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).
\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).
\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.
\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).
\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.
\n* The vertical unit for measurement of elevation height is meters.
\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).
\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).
\n\nSupports zoom levels 9 through 14. Format: vector (pbf)." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "MapTileV2Zoom": { + "name": "zoom", + "in": "query", + "description": "Zoom level for the desired tile. Please find TilesetID list below for more details on supported zoom level for each tilesetId.
\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" + }, + "Text": { + "name": "text", + "in": "query", + "description": "Yes/no value to exclude textual data from response. Only images and country names will be in response.", + "required": false, + "type": "string", + "enum": [ + "yes", + "no" + ], + "default": "yes", + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/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": "RenderV2_GetMapTile", + "x-ms-examples": { + "GetMapTile": { + "$ref": "./examples/GetMapTileV2.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/RenderApiVersionV2" + }, + { + "$ref": "#/parameters/TilesetId_rv2" + }, + { + "$ref": "#/parameters/MapTileV2Zoom" + }, + { + "$ref": "../1.0/render.json#/parameters/xTileIndex" + }, + { + "$ref": "../1.0/render.json#/parameters/yTileIndex" + }, + { + "name": "timeStamp", + "in": "query", + "description": "The desired date and time of the requested tile. This parameter must be specified in the standard date-time format (e.g. 2019-11-14T16:03:00-08:00), as defined by [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). This parameter is only supported when tilesetId parameter is set to one of the values below.\n \n* microsoft.weather.infrared.main: We provide tiles up to 3 hours in the past. Tiles are available in 10-minute intervals. We round the timeStamp value to the nearest 10-minute time frame.\n* microsoft.weather.radar.main: We provide tiles up to 1.5 hours in the past and up to 2 hours in the future. Tiles are available in 5-minute intervals. We round the timeStamp value to the nearest 5-minute time frame.", + "required": false, + "type": "string" + }, + { + "name": "tileSize", + "in": "query", + "description": "The size of the returned map tile in pixels.", + "required": false, + "type": "string", + "default": "256", + "enum": [ + "256", + "512" + ], + "x-ms-enum": { + "name": "TileSize", + "modelAsString": true, + "values": [ + { + "value": "256", + "description": "Return a 256 by 256 pixel tile. Available for all tilesetIds except for\n* microsoft.terra.main" + }, + { + "value": "512", + "description": "Return a 512 by 512 pixel tile. Available for all tilesetIds except for \n* microsoft.weather.radar.main\n* microsoft.weather.infrared.main\n* microsoft.base.hybrid\n* microsoft.dem\n* microsoft.imagery" + } + ] + } + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/Language" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/View" + } + ], + "produces": [ + "application/json", + "image/jpeg", + "image/png", + "image/pbf", + "application/vnd.mapbox-vector-tile" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MapTileResultv2" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/tileset": { + "get": { + "description": "**Applies to**: S0 and S1 pricing tiers.\n\nThe Get Map Tileset API allows users to request metadata for a tileset.", + "operationId": "RenderV2_GetMapTileset", + "x-ms-examples": { + "GetMapTile": { + "$ref": "./examples/GetMapTilesetV2.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/RenderApiVersionV2" + }, + { + "$ref": "#/parameters/TilesetId_rv2" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MapTilesetResultV2" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/attribution": { + "get": { + "description": "**Applies to**: S0 and S1 pricing tiers.\n\nThe Get Map Attribution API allows users to request map copyright attribution information for a section of a tileset.", + "operationId": "RenderV2_GetMapAttribution", + "x-ms-examples": { + "GetMapTile": { + "$ref": "./examples/GetMapAttributionV2.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/RenderApiVersionV2" + }, + { + "$ref": "#/parameters/TilesetId_rv2" + }, + { + "$ref": "#/parameters/MapTileV2Zoom" + }, + { + "name": "bounds", + "in": "query", + "description": "The string that represents the rectangular area of a bounding box. The bounds parameter is defined by the 4 bounding box coordinates, with WGS84 longitude and latitude of the southwest corner followed by WGS84 longitude and latitude of the northeast corner. The string is presented in the following format: `[SouthwestCorner_Longitude, SouthwestCorner_Latitude, NortheastCorner_Longitude, NortheastCorner_Latitude]`.", + "required": true, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MapAttributionResultV2" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "MapTileResultv2": { + "description": "The tile returned from a successful API call.", + "type": "string", + "format": "binary", + "readOnly": true + }, + "MapTilesetResultV2": { + "description": "Metadata for a tileset in the TileJSON format.", + "type": "object", + "readOnly": true, + "properties": { + "tilejson": { + "type": "string", + "pattern": "\\d+\\.\\d+\\.\\d+\\w?[\\w\\d]*", + "description": "Version of the TileJSON spec." + }, + "name": { + "type": "string", + "description": "Name of the tileset." + }, + "description": { + "type": "string", + "description": "Text description of the tileset." + }, + "version": { + "type": "string", + "pattern": "\\d+\\.\\d+\\.\\d+\\w?[\\w\\d]*", + "description": "A semver.org style version number for the tiles contained within the tileset." + }, + "attribution": { + "type": "string", + "description": "Copyright attribution to be displayed on the map." + }, + "template": { + "type": "string", + "description": "A mustache template to be used to format data from grids for interaction." + }, + "legend": { + "type": "string", + "description": "A legend to be displayed with the map." + }, + "scheme": { + "type": "string", + "description": "Default: \"xyz\". Either \"xyz\" or \"tms\". Influences the y direction of the tile coordinates." + }, + "tiles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of tile endpoints." + }, + "grids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of interactivity endpoints." + }, + "data": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of data files in GeoJSON format." + }, + "minzoom": { + "minimum": 0, + "maximum": 30, + "type": "integer", + "description": "The minimum zoom level." + }, + "maxzoom": { + "minimum": 0, + "maximum": 30, + "type": "integer", + "description": "The maximum zoom level." + }, + "bounds": { + "type": "array", + "items": { + "type": "number" + }, + "description": "The WGS84 bounds of the tileset." + }, + "center": { + "type": "array", + "items": { + "type": "number" + }, + "description": "The default location of the tileset in the form [longitude, latitude, zoom]." + } + } + }, + "MapAttributionResultV2": { + "description": "Copyright attribution for the requested section of a tileset.", + "type": "object", + "readOnly": true, + "properties": { + "copyrights": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of copyright strings." + } + } + } + } +} diff --git a/specification/maps/data-plane/Render/readme.go.md b/specification/maps/data-plane/Render/readme.go.md index d7a8bb1a3b80..e5665e8bf508 100644 --- a/specification/maps/data-plane/Render/readme.go.md +++ b/specification/maps/data-plane/Render/readme.go.md @@ -13,7 +13,16 @@ export-clients: true ``` yaml $(go) && $(multiapi) batch: - - tag: 2.0-preview + - tag: 2.1-preview +``` + +### Tag: 2.1-preview and go + +These settings apply only when `--tag=2.1-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == '2.1-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/maps/2.1/$(namespace) ``` ### Tag: 2.0-preview and go diff --git a/specification/maps/data-plane/Render/readme.md b/specification/maps/data-plane/Render/readme.md index ef50275bae4f..d401079d4948 100644 --- a/specification/maps/data-plane/Render/readme.md +++ b/specification/maps/data-plane/Render/readme.md @@ -27,13 +27,23 @@ These are the global settings for Render Client. ``` yaml title: RenderClient openapi-type: data-plane -tag: 2.0-preview +tag: 2.1-preview # at some point those credentials will move away to Swagger according to [this](https://github.com/Azure/autorest/issues/3718) add-credentials: true credential-default-policy-type: BearerTokenCredentialPolicy credential-scopes: https://atlas.microsoft.com/.default ``` +### Tag: 2.1-preview + +These settings apply only when `--tag=2.1-preview` is specified on the command line. + +``` yaml $(tag) == '2.1-preview' +input-file: + - preview/1.0/render.json + - preview/2.0/render.json + - preview/2.1/render.json +``` ### Tag: 2.0-preview From 94324f8bd40f1fb67bf12a35e15abd1b531ac303 Mon Sep 17 00:00:00 2001 From: ambientlight Date: Thu, 29 Jul 2021 01:19:57 +0800 Subject: [PATCH 02/15] GetAttribution response codes --- .../data-plane/Render/preview/2.1/render.json | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/specification/maps/data-plane/Render/preview/2.1/render.json b/specification/maps/data-plane/Render/preview/2.1/render.json index 470b715b5883..2003caa91b3f 100644 --- a/specification/maps/data-plane/Render/preview/2.1/render.json +++ b/specification/maps/data-plane/Render/preview/2.1/render.json @@ -392,6 +392,21 @@ "$ref": "#/definitions/MapAttributionResultV2" } }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + }, "default": { "$ref": "../../../Common/preview/1.0/common.json#/responses/default" } From 703c45f7ebe8cdff1e3751d6c597b1cd999030cb Mon Sep 17 00:00:00 2001 From: ambientlight Date: Thu, 29 Jul 2021 11:14:23 +0800 Subject: [PATCH 03/15] remove common error responses --- .../preview/2.0/examples/GetMapTileV2.json | 45 ---------- .../data-plane/Render/preview/2.0/render.json | 54 +----------- .../2.1/examples/GetMapAttributionV2.json | 45 ---------- .../preview/2.1/examples/GetMapTileV2.json | 45 ---------- .../preview/2.1/examples/GetMapTilesetV2.json | 45 ---------- .../data-plane/Render/preview/2.1/render.json | 84 +------------------ 6 files changed, 2 insertions(+), 316 deletions(-) diff --git a/specification/maps/data-plane/Render/preview/2.0/examples/GetMapTileV2.json b/specification/maps/data-plane/Render/preview/2.0/examples/GetMapTileV2.json index fe4c3d0aeefa..589af57c24fe 100644 --- a/specification/maps/data-plane/Render/preview/2.0/examples/GetMapTileV2.json +++ b/specification/maps/data-plane/Render/preview/2.0/examples/GetMapTileV2.json @@ -13,51 +13,6 @@ "Content-Type": "application/vnd.mapbox-vector-tile" }, "body": "{file}" - }, - "400": { - "headers": {}, - "body": { - "error": { - "code": "400 BadRequest", - "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." - } - } - }, - "401": { - "headers": {}, - "body": { - "error": { - "code": "401 Unauthorized", - "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." - } - } - }, - "403": { - "headers": {}, - "body": { - "error": { - "code": "403 Forbidden", - "message": "Permission, capacity, or authentication issues." - } - } - }, - "404": { - "headers": {}, - "body": { - "error": { - "code": "404 NotFound", - "message": "Not Found: the requested resource could not be found, but it may be available again in the future." - } - } - }, - "500": { - "headers": {}, - "body": { - "error": { - "code": "500 InternalServerError", - "message": "An error occurred while processing the request. Please try again later." - } - } } } } diff --git a/specification/maps/data-plane/Render/preview/2.0/render.json b/specification/maps/data-plane/Render/preview/2.0/render.json index 5a53bfdc567d..e635b46ef742 100644 --- a/specification/maps/data-plane/Render/preview/2.0/render.json +++ b/specification/maps/data-plane/Render/preview/2.0/render.json @@ -47,44 +47,7 @@ "AzureKey": [] } ], - "responses": { - "400": { - "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", - "schema": { - "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" - } - }, - "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", - "schema": { - "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" - }, - "headers": { - "WWW-Authenticate": { - "type": "string", - "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" - } - } - }, - "403": { - "description": "Permission, capacity, or authentication issues.", - "schema": { - "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" - } - }, - "404": { - "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", - "schema": { - "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" - } - }, - "500": { - "description": "An error occurred while processing the request. Please try again later.", - "schema": { - "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" - } - } - }, + "responses": {}, "parameters": { "RenderApiVersionV2": { "name": "api-version", @@ -274,21 +237,6 @@ } } }, - "400": { - "$ref": "#/responses/400" - }, - "401": { - "$ref": "#/responses/401" - }, - "403": { - "$ref": "#/responses/403" - }, - "404": { - "$ref": "#/responses/404" - }, - "500": { - "$ref": "#/responses/500" - }, "default": { "$ref": "../../../Common/preview/1.0/common.json#/responses/default" } 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 index c56fae2137ca..47de6f12f5e0 100644 --- a/specification/maps/data-plane/Render/preview/2.1/examples/GetMapAttributionV2.json +++ b/specification/maps/data-plane/Render/preview/2.1/examples/GetMapAttributionV2.json @@ -13,51 +13,6 @@ "© 2021 TomTom" ] } - }, - "400": { - "headers": {}, - "body": { - "error": { - "code": "400 BadRequest", - "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." - } - } - }, - "401": { - "headers": {}, - "body": { - "error": { - "code": "401 Unauthorized", - "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." - } - } - }, - "403": { - "headers": {}, - "body": { - "error": { - "code": "403 Forbidden", - "message": "Permission, capacity, or authentication issues." - } - } - }, - "404": { - "headers": {}, - "body": { - "error": { - "code": "404 NotFound", - "message": "Not Found: the requested resource could not be found, but it may be available again in the future." - } - } - }, - "500": { - "headers": {}, - "body": { - "error": { - "code": "500 InternalServerError", - "message": "An error occurred while processing the request. Please try again later." - } - } } } } 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 index ee2c24d32585..1bfc83ec8bfc 100644 --- a/specification/maps/data-plane/Render/preview/2.1/examples/GetMapTileV2.json +++ b/specification/maps/data-plane/Render/preview/2.1/examples/GetMapTileV2.json @@ -10,51 +10,6 @@ "200": { "headers": {}, "body": "binary string image" - }, - "400": { - "headers": {}, - "body": { - "error": { - "code": "400 BadRequest", - "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." - } - } - }, - "401": { - "headers": {}, - "body": { - "error": { - "code": "401 Unauthorized", - "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." - } - } - }, - "403": { - "headers": {}, - "body": { - "error": { - "code": "403 Forbidden", - "message": "Permission, capacity, or authentication issues." - } - } - }, - "404": { - "headers": {}, - "body": { - "error": { - "code": "404 NotFound", - "message": "Not Found: the requested resource could not be found, but it may be available again in the future." - } - } - }, - "500": { - "headers": {}, - "body": { - "error": { - "code": "500 InternalServerError", - "message": "An error occurred while processing the request. Please try again later." - } - } } } } 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 index da367b6d38cd..cc91082b9526 100644 --- a/specification/maps/data-plane/Render/preview/2.1/examples/GetMapTilesetV2.json +++ b/specification/maps/data-plane/Render/preview/2.1/examples/GetMapTilesetV2.json @@ -23,51 +23,6 @@ 90 ] } - }, - "400": { - "headers": {}, - "body": { - "error": { - "code": "400 BadRequest", - "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." - } - } - }, - "401": { - "headers": {}, - "body": { - "error": { - "code": "401 Unauthorized", - "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." - } - } - }, - "403": { - "headers": {}, - "body": { - "error": { - "code": "403 Forbidden", - "message": "Permission, capacity, or authentication issues." - } - } - }, - "404": { - "headers": {}, - "body": { - "error": { - "code": "404 NotFound", - "message": "Not Found: the requested resource could not be found, but it may be available again in the future." - } - } - }, - "500": { - "headers": {}, - "body": { - "error": { - "code": "500 InternalServerError", - "message": "An error occurred while processing the request. Please try again later." - } - } } } } diff --git a/specification/maps/data-plane/Render/preview/2.1/render.json b/specification/maps/data-plane/Render/preview/2.1/render.json index 2003caa91b3f..a07bc27650a9 100644 --- a/specification/maps/data-plane/Render/preview/2.1/render.json +++ b/specification/maps/data-plane/Render/preview/2.1/render.json @@ -41,44 +41,7 @@ "AzureKey": [] } ], - "responses": { - "400": { - "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", - "schema": { - "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" - } - }, - "401": { - "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", - "schema": { - "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" - }, - "headers": { - "WWW-Authenticate": { - "type": "string", - "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" - } - } - }, - "403": { - "description": "Permission, capacity, or authentication issues.", - "schema": { - "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" - } - }, - "404": { - "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", - "schema": { - "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" - } - }, - "500": { - "description": "An error occurred while processing the request. Please try again later.", - "schema": { - "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" - } - } - }, + "responses": {}, "parameters": { "RenderApiVersionV2": { "name": "api-version", @@ -276,21 +239,6 @@ "$ref": "#/definitions/MapTileResultv2" } }, - "400": { - "$ref": "#/responses/400" - }, - "401": { - "$ref": "#/responses/401" - }, - "403": { - "$ref": "#/responses/403" - }, - "404": { - "$ref": "#/responses/404" - }, - "500": { - "$ref": "#/responses/500" - }, "default": { "$ref": "../../../Common/preview/1.0/common.json#/responses/default" } @@ -327,21 +275,6 @@ "$ref": "#/definitions/MapTilesetResultV2" } }, - "400": { - "$ref": "#/responses/400" - }, - "401": { - "$ref": "#/responses/401" - }, - "403": { - "$ref": "#/responses/403" - }, - "404": { - "$ref": "#/responses/404" - }, - "500": { - "$ref": "#/responses/500" - }, "default": { "$ref": "../../../Common/preview/1.0/common.json#/responses/default" } @@ -392,21 +325,6 @@ "$ref": "#/definitions/MapAttributionResultV2" } }, - "400": { - "$ref": "#/responses/400" - }, - "401": { - "$ref": "#/responses/401" - }, - "403": { - "$ref": "#/responses/403" - }, - "404": { - "$ref": "#/responses/404" - }, - "500": { - "$ref": "#/responses/500" - }, "default": { "$ref": "../../../Common/preview/1.0/common.json#/responses/default" } From 6ce97d384798ebfc5a9cc0950fe2a76e7f47aeaa Mon Sep 17 00:00:00 2001 From: ambientlight Date: Thu, 29 Jul 2021 11:35:19 +0800 Subject: [PATCH 04/15] go multiapi batch should include 2.0 --- specification/maps/data-plane/Render/readme.go.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/maps/data-plane/Render/readme.go.md b/specification/maps/data-plane/Render/readme.go.md index e5665e8bf508..309634d3db6f 100644 --- a/specification/maps/data-plane/Render/readme.go.md +++ b/specification/maps/data-plane/Render/readme.go.md @@ -13,6 +13,7 @@ export-clients: true ``` yaml $(go) && $(multiapi) batch: + - tag: 2.0-preview - tag: 2.1-preview ``` From 6d467547643a36fc9bca85daa041ce9520f833de Mon Sep 17 00:00:00 2001 From: ambientlight Date: Thu, 29 Jul 2021 11:49:13 +0800 Subject: [PATCH 05/15] fix openapi 3.0 definition of file response, keep content-type --- .../maps/data-plane/Render/preview/2.1/render.json | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/specification/maps/data-plane/Render/preview/2.1/render.json b/specification/maps/data-plane/Render/preview/2.1/render.json index a07bc27650a9..7c706108f000 100644 --- a/specification/maps/data-plane/Render/preview/2.1/render.json +++ b/specification/maps/data-plane/Render/preview/2.1/render.json @@ -323,6 +323,12 @@ "description": "OK", "schema": { "$ref": "#/definitions/MapAttributionResultV2" + }, + "headers": { + "Content-Type": { + "type": "string", + "description": "The content-type for the response." + } } }, "default": { @@ -335,8 +341,8 @@ "definitions": { "MapTileResultv2": { "description": "The tile returned from a successful API call.", - "type": "string", - "format": "binary", + "type": "object", + "format": "file", "readOnly": true }, "MapTilesetResultV2": { From bb581ba380baa2e60cf99db8a8bed06c1a77a47e Mon Sep 17 00:00:00 2001 From: ambientlight Date: Thu, 29 Jul 2021 12:01:41 +0800 Subject: [PATCH 06/15] keep operationId between 2.0 and 2.1 --- specification/maps/data-plane/Render/preview/2.1/render.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/maps/data-plane/Render/preview/2.1/render.json b/specification/maps/data-plane/Render/preview/2.1/render.json index 7c706108f000..a7629996057a 100644 --- a/specification/maps/data-plane/Render/preview/2.1/render.json +++ b/specification/maps/data-plane/Render/preview/2.1/render.json @@ -160,7 +160,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": "RenderV2_GetMapTile", + "operationId": "RenderV2_GetMapTilePreview", "x-ms-examples": { "GetMapTile": { "$ref": "./examples/GetMapTileV2.json" From 04f9825c5b793b628b670046cc6a2432c9186cd0 Mon Sep 17 00:00:00 2001 From: ambientlight Date: Thu, 29 Jul 2021 12:47:29 +0800 Subject: [PATCH 07/15] update samples and header response --- .../preview/2.1/examples/GetMapTileV2.json | 6 ++++-- .../data-plane/Render/preview/2.1/render.json | 16 ++++++++-------- 2 files changed, 12 insertions(+), 10 deletions(-) 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 index 1bfc83ec8bfc..704199bbd1e7 100644 --- a/specification/maps/data-plane/Render/preview/2.1/examples/GetMapTileV2.json +++ b/specification/maps/data-plane/Render/preview/2.1/examples/GetMapTileV2.json @@ -8,8 +8,10 @@ }, "responses": { "200": { - "headers": {}, - "body": "binary string image" + "headers": { + "Content-Type": "application/vnd.mapbox-vector-tile" + }, + "body": "{file}" } } } diff --git a/specification/maps/data-plane/Render/preview/2.1/render.json b/specification/maps/data-plane/Render/preview/2.1/render.json index a7629996057a..0698bde527f9 100644 --- a/specification/maps/data-plane/Render/preview/2.1/render.json +++ b/specification/maps/data-plane/Render/preview/2.1/render.json @@ -237,6 +237,12 @@ "description": "OK", "schema": { "$ref": "#/definitions/MapTileResultv2" + }, + "headers": { + "Content-Type": { + "type": "string", + "description": "The content-type for the response." + } } }, "default": { @@ -250,7 +256,7 @@ "description": "**Applies to**: S0 and S1 pricing tiers.\n\nThe Get Map Tileset API allows users to request metadata for a tileset.", "operationId": "RenderV2_GetMapTileset", "x-ms-examples": { - "GetMapTile": { + "GetMapTileset": { "$ref": "./examples/GetMapTilesetV2.json" } }, @@ -286,7 +292,7 @@ "description": "**Applies to**: S0 and S1 pricing tiers.\n\nThe Get Map Attribution API allows users to request map copyright attribution information for a section of a tileset.", "operationId": "RenderV2_GetMapAttribution", "x-ms-examples": { - "GetMapTile": { + "GetMapAttribution": { "$ref": "./examples/GetMapAttributionV2.json" } }, @@ -323,12 +329,6 @@ "description": "OK", "schema": { "$ref": "#/definitions/MapAttributionResultV2" - }, - "headers": { - "Content-Type": { - "type": "string", - "description": "The content-type for the response." - } } }, "default": { From b55ba5e61ecfce7cdf2f39f7dce40b3a414d5f5d Mon Sep 17 00:00:00 2001 From: ambientlight Date: Fri, 30 Jul 2021 02:15:08 +0800 Subject: [PATCH 08/15] exclude 2.0 from 2.1-preview tag, refs in 2.1 params, remove used Text param --- .../data-plane/Render/preview/2.0/render.json | 1 + .../data-plane/Render/preview/2.1/render.json | 126 ++---------------- .../maps/data-plane/Render/readme.md | 1 - 3 files changed, 14 insertions(+), 114 deletions(-) diff --git a/specification/maps/data-plane/Render/preview/2.0/render.json b/specification/maps/data-plane/Render/preview/2.0/render.json index e635b46ef742..bce13a09eb7d 100644 --- a/specification/maps/data-plane/Render/preview/2.0/render.json +++ b/specification/maps/data-plane/Render/preview/2.0/render.json @@ -181,6 +181,7 @@ { "name": "timeStamp", "in": "query", + "format": "date-time", "description": "The desired date and time of the requested tile. This parameter must be specified in the standard date-time format (e.g. 2019-11-14T16:03:00-08:00), as defined by [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). This parameter is only supported when tilesetId parameter is set to one of the values below.\n \n* microsoft.weather.infrared.main: We provide tiles up to 3 hours in the past. Tiles are available in 10-minute intervals. We round the timeStamp value to the nearest 10-minute time frame.\n* microsoft.weather.radar.main: We provide tiles up to 1.5 hours in the past and up to 2 hours in the future. Tiles are available in 5-minute intervals. We round the timeStamp value to the nearest 5-minute time frame.", "type": "string" }, diff --git a/specification/maps/data-plane/Render/preview/2.1/render.json b/specification/maps/data-plane/Render/preview/2.1/render.json index 0698bde527f9..5da684f22103 100644 --- a/specification/maps/data-plane/Render/preview/2.1/render.json +++ b/specification/maps/data-plane/Render/preview/2.1/render.json @@ -51,109 +51,6 @@ "required": true, "default": "2.1", "x-ms-parameter-location": "client" - }, - "TilesetId_rv2": { - "name": "tilesetId", - "description": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the [Tileset Create API](https://docs.microsoft.com/en-us/rest/api/maps/tileset). The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.", - "type": "string", - "in": "query", - "required": true, - "enum": [ - "microsoft.base", - "microsoft.base.labels", - "microsoft.base.hybrid", - "microsoft.terra.main", - "microsoft.base.road", - "microsoft.base.darkgrey", - "microsoft.base.labels.road", - "microsoft.base.hybrid.road", - "microsoft.imagery", - "microsoft.weather.radar.main", - "microsoft.weather.infrared.main", - "microsoft.dem", - "microsoft.dem.contours" - ], - "x-ms-enum": { - "name": "TilesetID", - "modelAsString": true, - "values": [ - { - "value": "microsoft.base", - "description": "A base map is a standard map that displays roads, natural and artificial features along with the labels for those features in a vector tile.
\n\nSupports zoom levels 0 through 22. Format: vector (pbf)." - }, - { - "value": "microsoft.base.labels", - "description": "Displays labels for roads, natural and artificial features in a vector tile.
\n\nSupports zoom levels 0 through 22. Format: vector (pbf)." - }, - { - "value": "microsoft.base.hybrid", - "description": "Displays road, boundary and label data in a vector tile.
\n\nSupports zoom levels 0 through 22. Format: vector (pbf)." - }, - { - "value": "microsoft.terra.main", - "description": "Shaded relief and terra layers.
\n\nSupports zoom levels 0 through 6. Format: raster (png)." - }, - { - "value": "microsoft.base.road", - "description": "All layers with our main style.
\n\nSupports zoom levels 0 through 22. Format: raster (png)." - }, - { - "value": "microsoft.base.darkgrey", - "description": "All layers with our dark grey style.
\n\nSupports zoom levels 0 through 22. Format: raster (png)." - }, - { - "value": "microsoft.base.labels.road", - "description": "Label data in our main style.
\n\nSupports zoom levels 0 through 22. Format: raster (png)." - }, - { - "value": "microsoft.base.hybrid.road", - "description": "Road, boundary and label data in our main style.
\n\nSupports zoom levels 0 through 22. Format: raster (png)." - }, - { - "value": "microsoft.imagery", - "description": "A combination of satellite and aerial imagery. Only available in S1 pricing SKU.
\n\nSupports zoom levels 1 through 19. Format: raster (jpeg)." - }, - { - "value": "microsoft.weather.radar.main", - "description": "Weather radar tiles. Latest weather radar images including areas of rain, snow, ice and mixed conditions. Please see [coverage information](https://aka.ms/AzureMapsWeatherCoverage) for Azure Maps Weather service. To learn more about the Radar data, please see [Weather concepts](https://aka.ms/AzureMapsWeatherConcepts).
\n\nSupports zoom levels 0 through 15. Format: raster (png)." - }, - { - "value": "microsoft.weather.infrared.main", - "description": "Weather infrared tiles. Latest Infrared Satellite images shows clouds by their temperature. Please see [coverage information](https://aka.ms/AzureMapsWeatherCoverage) for Azure Maps Weather service. To learn more about the returned Satellite data, please see [Weather concepts](https://aka.ms/AzureMapsWeatherConcepts).
\n\nSupports zoom levels 0 through 15. Format: raster (png)." - }, - { - "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.
\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).
\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).
\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.
\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).
\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.
\n* The vertical unit for measurement of elevation height is meters.
\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).
\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).
\n\nSupports zoom levels 9 through 14. Format: vector (pbf)." - } - ] - }, - "x-ms-parameter-location": "method" - }, - "MapTileV2Zoom": { - "name": "zoom", - "in": "query", - "description": "Zoom level for the desired tile. Please find TilesetID list below for more details on supported zoom level for each tilesetId.
\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" - }, - "Text": { - "name": "text", - "in": "query", - "description": "Yes/no value to exclude textual data from response. Only images and country names will be in response.", - "required": false, - "type": "string", - "enum": [ - "yes", - "no" - ], - "default": "yes", - "x-ms-parameter-location": "method" } }, "paths": { @@ -171,13 +68,13 @@ "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" }, { - "$ref": "#/parameters/RenderApiVersionV2" + "$ref": "../2.0/render.json#/parameters/RenderApiVersionV2" }, { - "$ref": "#/parameters/TilesetId_rv2" + "$ref": "../2.0/render.json#/parameters/TilesetId_rv2" }, { - "$ref": "#/parameters/MapTileV2Zoom" + "$ref": "../2.0/render.json#/parameters/MapTileV2Zoom" }, { "$ref": "../1.0/render.json#/parameters/xTileIndex" @@ -188,6 +85,7 @@ { "name": "timeStamp", "in": "query", + "format": "date-time", "description": "The desired date and time of the requested tile. This parameter must be specified in the standard date-time format (e.g. 2019-11-14T16:03:00-08:00), as defined by [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). This parameter is only supported when tilesetId parameter is set to one of the values below.\n \n* microsoft.weather.infrared.main: We provide tiles up to 3 hours in the past. Tiles are available in 10-minute intervals. We round the timeStamp value to the nearest 10-minute time frame.\n* microsoft.weather.radar.main: We provide tiles up to 1.5 hours in the past and up to 2 hours in the future. Tiles are available in 5-minute intervals. We round the timeStamp value to the nearest 5-minute time frame.", "required": false, "type": "string" @@ -234,9 +132,11 @@ ], "responses": { "200": { - "description": "OK", + "description": "The tile returned from a successful API call.", "schema": { - "$ref": "#/definitions/MapTileResultv2" + "type": "object", + "format": "file", + "readOnly": true }, "headers": { "Content-Type": { @@ -265,10 +165,10 @@ "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" }, { - "$ref": "#/parameters/RenderApiVersionV2" + "$ref": "../2.0/render.json#/parameters/RenderApiVersionV2" }, { - "$ref": "#/parameters/TilesetId_rv2" + "$ref": "../2.0/render.json#/parameters/TilesetId_rv2" } ], "produces": [ @@ -301,13 +201,13 @@ "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" }, { - "$ref": "#/parameters/RenderApiVersionV2" + "$ref": "../2.0/render.json#/parameters/RenderApiVersionV2" }, { - "$ref": "#/parameters/TilesetId_rv2" + "$ref": "../2.0/render.json#/parameters/TilesetId_rv2" }, { - "$ref": "#/parameters/MapTileV2Zoom" + "$ref": "../2.0/render.json#/parameters/MapTileV2Zoom" }, { "name": "bounds", diff --git a/specification/maps/data-plane/Render/readme.md b/specification/maps/data-plane/Render/readme.md index d401079d4948..742c370a1a2b 100644 --- a/specification/maps/data-plane/Render/readme.md +++ b/specification/maps/data-plane/Render/readme.md @@ -41,7 +41,6 @@ These settings apply only when `--tag=2.1-preview` is specified on the command l ``` yaml $(tag) == '2.1-preview' input-file: - preview/1.0/render.json - - preview/2.0/render.json - preview/2.1/render.json ``` From a5954cb6b793e75eaaa56745d2e83131424fd5d9 Mon Sep 17 00:00:00 2001 From: ambientlight Date: Fri, 30 Jul 2021 02:21:24 +0800 Subject: [PATCH 09/15] refrain from changing 2.0 timestamp format --- specification/maps/data-plane/Render/preview/2.0/render.json | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/maps/data-plane/Render/preview/2.0/render.json b/specification/maps/data-plane/Render/preview/2.0/render.json index bce13a09eb7d..e635b46ef742 100644 --- a/specification/maps/data-plane/Render/preview/2.0/render.json +++ b/specification/maps/data-plane/Render/preview/2.0/render.json @@ -181,7 +181,6 @@ { "name": "timeStamp", "in": "query", - "format": "date-time", "description": "The desired date and time of the requested tile. This parameter must be specified in the standard date-time format (e.g. 2019-11-14T16:03:00-08:00), as defined by [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). This parameter is only supported when tilesetId parameter is set to one of the values below.\n \n* microsoft.weather.infrared.main: We provide tiles up to 3 hours in the past. Tiles are available in 10-minute intervals. We round the timeStamp value to the nearest 10-minute time frame.\n* microsoft.weather.radar.main: We provide tiles up to 1.5 hours in the past and up to 2 hours in the future. Tiles are available in 5-minute intervals. We round the timeStamp value to the nearest 5-minute time frame.", "type": "string" }, From aa8b25e9db3f630a9f807960c3b3b3ad515be865 Mon Sep 17 00:00:00 2001 From: ambientlight Date: Fri, 30 Jul 2021 02:23:42 +0800 Subject: [PATCH 10/15] remove default in tileSize --- specification/maps/data-plane/Render/preview/2.1/render.json | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/maps/data-plane/Render/preview/2.1/render.json b/specification/maps/data-plane/Render/preview/2.1/render.json index 5da684f22103..e25a3c29327b 100644 --- a/specification/maps/data-plane/Render/preview/2.1/render.json +++ b/specification/maps/data-plane/Render/preview/2.1/render.json @@ -96,7 +96,6 @@ "description": "The size of the returned map tile in pixels.", "required": false, "type": "string", - "default": "256", "enum": [ "256", "512" From f41a1ef8a181e93afed039c53feade357a2dd338 Mon Sep 17 00:00:00 2001 From: ambientlight Date: Fri, 30 Jul 2021 02:24:54 +0800 Subject: [PATCH 11/15] remove redundant required: false --- specification/maps/data-plane/Render/preview/2.1/render.json | 2 -- 1 file changed, 2 deletions(-) diff --git a/specification/maps/data-plane/Render/preview/2.1/render.json b/specification/maps/data-plane/Render/preview/2.1/render.json index e25a3c29327b..56e5630f5d9a 100644 --- a/specification/maps/data-plane/Render/preview/2.1/render.json +++ b/specification/maps/data-plane/Render/preview/2.1/render.json @@ -87,14 +87,12 @@ "in": "query", "format": "date-time", "description": "The desired date and time of the requested tile. This parameter must be specified in the standard date-time format (e.g. 2019-11-14T16:03:00-08:00), as defined by [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). This parameter is only supported when tilesetId parameter is set to one of the values below.\n \n* microsoft.weather.infrared.main: We provide tiles up to 3 hours in the past. Tiles are available in 10-minute intervals. We round the timeStamp value to the nearest 10-minute time frame.\n* microsoft.weather.radar.main: We provide tiles up to 1.5 hours in the past and up to 2 hours in the future. Tiles are available in 5-minute intervals. We round the timeStamp value to the nearest 5-minute time frame.", - "required": false, "type": "string" }, { "name": "tileSize", "in": "query", "description": "The size of the returned map tile in pixels.", - "required": false, "type": "string", "enum": [ "256", From 27f48636b5e9a49497664322bd81d7db9c6f8525 Mon Sep 17 00:00:00 2001 From: ambientlight Date: Fri, 30 Jul 2021 02:25:45 +0800 Subject: [PATCH 12/15] bump python package version --- specification/maps/data-plane/Render/readme.python.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/maps/data-plane/Render/readme.python.md b/specification/maps/data-plane/Render/readme.python.md index 7e61eefced21..5ac67a238fe9 100644 --- a/specification/maps/data-plane/Render/readme.python.md +++ b/specification/maps/data-plane/Render/readme.python.md @@ -9,7 +9,7 @@ python-mode: create license-header: MICROSOFT_MIT_NO_VERSION namespace: azure.maps.render package-name: azure-maps-render -package-version: 2.0-preview +package-version: 2.1-preview clear-output-folder: true ``` ``` yaml $(python) && $(python-mode) == 'update' From d735482b7d8235bdfe0096b38709e2582ec10b42 Mon Sep 17 00:00:00 2001 From: ambientlight Date: Thu, 5 Aug 2021 17:08:26 +0800 Subject: [PATCH 13/15] make sure there is no cross-client parameter references - move all shared into Common --- .../data-plane/Common/preview/1.0/common.json | 20 +++++++++ .../data-plane/Render/preview/1.0/render.json | 44 +++++-------------- .../data-plane/Render/preview/2.0/render.json | 4 +- .../data-plane/Render/preview/2.1/render.json | 4 +- .../Traffic/preview/1.0/traffic.json | 8 ++-- 5 files changed, 40 insertions(+), 40 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 index baaf6b454f95..be11a5a2f621 100644 --- a/specification/maps/data-plane/Common/preview/1.0/common.json +++ b/specification/maps/data-plane/Common/preview/1.0/common.json @@ -626,6 +626,26 @@ "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`zoom` -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`zoom` -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 index b3551dd7c2b8..79099d3ce129 100644 --- 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`zoom` -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`zoom` -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 index e635b46ef742..56f608740f71 100644 --- a/specification/maps/data-plane/Render/preview/2.0/render.json +++ b/specification/maps/data-plane/Render/preview/2.0/render.json @@ -173,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", diff --git a/specification/maps/data-plane/Render/preview/2.1/render.json b/specification/maps/data-plane/Render/preview/2.1/render.json index 56e5630f5d9a..163b2a5b68f9 100644 --- a/specification/maps/data-plane/Render/preview/2.1/render.json +++ b/specification/maps/data-plane/Render/preview/2.1/render.json @@ -77,10 +77,10 @@ "$ref": "../2.0/render.json#/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", diff --git a/specification/maps/data-plane/Traffic/preview/1.0/traffic.json b/specification/maps/data-plane/Traffic/preview/1.0/traffic.json index 55d16316e516..cc860ed0e133 100644 --- a/specification/maps/data-plane/Traffic/preview/1.0/traffic.json +++ b/specification/maps/data-plane/Traffic/preview/1.0/traffic.json @@ -162,10 +162,10 @@ "$ref": "#/parameters/RasterVectorZoom" }, { - "$ref": "../../../Render/preview/1.0/render.json#/parameters/xTileIndex" + "$ref": "../../../Common/preview/1.0/common.json#/parameters/xTileIndex" }, { - "$ref": "../../../Render/preview/1.0/render.json#/parameters/yTileIndex" + "$ref": "../../../Common/preview/1.0/common.json#/parameters/yTileIndex" }, { "name": "thickness", @@ -361,10 +361,10 @@ "$ref": "#/parameters/RasterVectorZoom" }, { - "$ref": "../../../Render/preview/1.0/render.json#/parameters/xTileIndex" + "$ref": "../../../Common/preview/1.0/common.json#/parameters/xTileIndex" }, { - "$ref": "../../../Render/preview/1.0/render.json#/parameters/yTileIndex" + "$ref": "../../../Common/preview/1.0/common.json#/parameters/yTileIndex" }, { "name": "t", From 606a4f10d9db5880d87b4743160003a5bfe56b9f Mon Sep 17 00:00:00 2001 From: ambientlight Date: Thu, 5 Aug 2021 18:44:19 +0800 Subject: [PATCH 14/15] remove non-supported application/xml MIME --- specification/maps/data-plane/Render/preview/2.1/render.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/specification/maps/data-plane/Render/preview/2.1/render.json b/specification/maps/data-plane/Render/preview/2.1/render.json index 163b2a5b68f9..a072f6355e90 100644 --- a/specification/maps/data-plane/Render/preview/2.1/render.json +++ b/specification/maps/data-plane/Render/preview/2.1/render.json @@ -11,8 +11,7 @@ ], "consumes": [], "produces": [ - "application/json", - "application/xml" + "application/json" ], "securityDefinitions": { "AADToken": { From 71bee12f91b4fce33bb8095a962cff4f6b6ab23d Mon Sep 17 00:00:00 2001 From: ambientlight Date: Fri, 6 Aug 2021 16:09:37 +0800 Subject: [PATCH 15/15] use local apiversion param def --- .../maps/data-plane/Render/preview/2.1/render.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/maps/data-plane/Render/preview/2.1/render.json b/specification/maps/data-plane/Render/preview/2.1/render.json index a072f6355e90..075aaddc7e3a 100644 --- a/specification/maps/data-plane/Render/preview/2.1/render.json +++ b/specification/maps/data-plane/Render/preview/2.1/render.json @@ -67,7 +67,7 @@ "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" }, { - "$ref": "../2.0/render.json#/parameters/RenderApiVersionV2" + "$ref": "#/parameters/RenderApiVersionV2" }, { "$ref": "../2.0/render.json#/parameters/TilesetId_rv2" @@ -161,7 +161,7 @@ "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" }, { - "$ref": "../2.0/render.json#/parameters/RenderApiVersionV2" + "$ref": "#/parameters/RenderApiVersionV2" }, { "$ref": "../2.0/render.json#/parameters/TilesetId_rv2" @@ -197,7 +197,7 @@ "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" }, { - "$ref": "../2.0/render.json#/parameters/RenderApiVersionV2" + "$ref": "#/parameters/RenderApiVersionV2" }, { "$ref": "../2.0/render.json#/parameters/TilesetId_rv2"