diff --git a/specification/maps/data-plane/Render/readme.md b/specification/maps/data-plane/Render/readme.md index 2df50d44fdd8..ff0ba8a3aa5f 100644 --- a/specification/maps/data-plane/Render/readme.md +++ b/specification/maps/data-plane/Render/readme.md @@ -27,11 +27,10 @@ These are the global settings for Render Client. ``` yaml title: RenderClient openapi-type: data-plane -tag: 2.1 # removed "preview" as it started causing validation errors from v0.26 of the Swagger Lintdiff. -# at some point those credentials will move away to Swagger according to [this](https://github.com/Azure/autorest/issues/3718) +tag: package-2024-04-01 add-credentials: true credential-default-policy-type: BearerTokenCredentialPolicy -credential-scopes: https://atlas.microsoft.com/.default +credential-scopes: 'https://atlas.microsoft.com/.default' track2: true verbose: true sdk-integration: true @@ -48,9 +47,19 @@ directive: reason: false positive from oav is breaking our example validation. See azure/oav#1021. ``` + +### Tag: package-2024-04-01 + +These settings apply only when `--tag=package-2024-04-01` is specified on the command line. + +```yaml $(tag) == 'package-2024-04-01' +input-file: + - stable/2024-04-01/render.json +``` ### Tag: 2022-08-01 These settings apply only when `--tag=2022-08-01` is specified on the command line. + ``` yaml $(tag) == '2022-08-01' input-file: - stable/2022-08-01/render.json diff --git a/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightCaption.json b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightCaption.json new file mode 100644 index 000000000000..97ca0985da46 --- /dev/null +++ b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightCaption.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "format": "json" + }, + "responses": { + "200": { + "body": { + "formatVersion": "0.0.1", + "copyrightsCaption": "© 1992 - 2022 TomTom." + } + } + } +} diff --git a/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightForTile.json b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightForTile.json new file mode 100644 index 000000000000..c4ff7adfa4c0 --- /dev/null +++ b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightForTile.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "format": "json", + "zoom": 6, + "x": 9, + "y": 22 + }, + "responses": { + "200": { + "body": { + "formatVersion": "0.0.1", + "generalCopyrights": [ + "© 1992 - 2022 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection, database right protection and other intellectual property rights owned by TomTom or its suppliers. The use of this material is subject to the terms of a license agreement. Any unauthorized copying or disclosure of this material will lead to criminal and civil liabilities.", + "Data Source © 2022 TomTom", + "based on" + ], + "regions": [ + { + "country": { + "ISO3": "CAN", + "label": "Canada" + }, + "copyrights": [ + "You agree to include as soon as practically possible, but no later than the first new release of the Authorized Application following Your receipt of any 3D Landmarks, any copyright notices related to the display of such landmarks on every Authorized Application and in the “about box” of the Authorized Application. Notwithstanding the aforementioned, TomTom has the right to decide, at its sole discretion, to remove specific 3D Landmarks in subsequent releases of the Licensed Products. In such case, You will remove those 3D Landmarks from the Authorized Application as soon as practically possible, but not later than the first new release of the Authorized Application following Your receipt of the Update to the Licensed Product. TomTom shall not be held responsible for any possible damages, costs or expenses incurred by You related to such removal of a 3D Landmark by TomTom from the Licensed Product or failure to remove a 3D Landmark by You from the Authorized Application.", + "TomTom hereby grants to You a non-exclusive, non-transferable license to use the Software Licensed Products for the sole and limited purpose of assisting You in viewing, analyzing and sectioning the Licensed Products. In no event shall You use the Software Licensed Products to view, analyze, section or in any way manipulate spatial map data that is not provided by TomTom. You shall not derive or attempt to derive the source code of all or any portion of the Licensed Products by reverse engineering, disassembly, decompilation, translation or any other means. You shall affix the following copyright notice on any copy of the GDF Viewer, or any portion of the Licensed Products: “Software ©2011-2020 TomTom North America, Inc. All rights reserved.", + "Neither the Data nor the Licensed Products such as Speed Profiles or TomTom Traffic or any derivatives thereof shall be used for the purpose of enforcement of traffic laws including but not limited to the selection of potential locations for the installation of speed cameras, speed traps or other speed tracking devices. With regards to Speed Profiles, You acknowledge and agrees that the actual speeds may not reflect the legally imposed speed limits.", + "You specifically agree that it shall not: (i) store the data for more than twenty-four (24) hours on Your servers; (ii) broadcast or make Live Services Licensed Products available except to authorized End Users; and (iii) use the feed or information received via the feed for historical data purposes (including but not limited to collection or analysis).", + "© 1992 – 2021 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection and other intellectual property rights owned or licensed to TomTom. The product includes information copied with permission from Canadian authorities, including © Canada Post Corporation. All rights reserved. The use of this material is subject to the terms of a License Agreement. You will be held liable for any unauthorized copying or disclosure of this material.", + "The following copyright notice applies to the use of Post- FSA layer and 6-digit layer: © 1992 – 2021 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection and other intellectual property rights owned or licensed to TomTom. The product includes information copied with permission from Canadian authorities, including © Canada Post Corporation, All rights reserved. The use of this material is subject to the terms of a License Agreement. You will be held liable for any unauthorized copying or disclosure of this material. The following copyright notice applies to the use of Points of Interest: © 1992 – 2021 TomTom. All rights reserved. Portions of the POI database contained in Points of Interest North America have been provided by Neustar Localeze The following copyright notice applies to the use of Telecommunications: © 2021 Pitney Bowes Software Inc. All rights reserved. This product contains information and/or data of iconectiv, licensed to be included herein. Copyright © 2021 iconectiv. All rights reserved. The following copyright notice applies to the use of Logistics: © 1992 – 2021 TomTom. Truck Attribute Data © 2004 - 2021 ProMiles Software Development Corporation. All rights reserved. This material is proprietary and the subject of copyright protection and other intellectual property rights owned or licensed to TomTom.", + "The 6-digit alpha/numeric Canadian Postal Codes contained in any Licensed Product cannot be used for bulk mailing of items through the Canadian postal system. Furthermore, the 6-digit alpha/numeric Canadian Postal Codes must be wholly contained in the Authorized Application and shall not be extractable. Canadian Postal Codes cannot be displayed or used for postal code look-up on the Internet, nor can they be extracted or exported from any application to be utilized in the creation of any other data set or application. Notwithstanding the above, an End User may optionally correct or derive Canadian Postal Codes using the Authorized Application, but only as part of the address information for locations (e.g.: of delivery points and depots) that have been set up in the Authorized Application, and optionally extract data for fleet management purposes.", + "This product contains information adapted from Statistics Canada: Boundary Files, 2016 Census; Road Network File, 2018; and Census Population and Dwelling Count Highlight Tables, 2016 Census. This does not constitute an endorsement by Statistics Canada of this product.", + "Contains information licensed under Open Government Licence – Canada.", + "Contains data made available by GeoNames licensed under CC-BY 4.0. For more information visit http://www.geonames.org/.", + "Contains information provided by TransLink (South Coast British Columbia Transportation Authority) under the modified open GTFS Data Terms of Use Agreement. For specifics: https://developer.translink.ca/ServicesGtfs/GtfsData", + "Contains information licensed under Open Government Licence: * Vancouver * City of Victoria * British Columbia * City of Surrey * Kamloops * Nanaimo * City of Westminster * City of Prince George * Burnaby * City of Kelowna * Maple Ridge * North Vancouver" + ] + }, + { + "country": { + "ISO3": "OCP", + "label": "" + }, + "copyrights": [ + "You agree to include as soon as practically possible, but no later than the first new release of the Authorized Application following Your receipt of any 3D Landmarks, any copyright notices related to the display of such landmarks on every Authorized Application and in the “about box” of the Authorized Application. Notwithstanding the aforementioned, TomTom has the right to decide, at its sole discretion, to remove specific 3D Landmarks in subsequent releases of the Licensed Products. In such case, You will remove those 3D Landmarks from the Authorized Application as soon as practically possible, but not later than the first new release of the Authorized Application following Your receipt of the Update to the Licensed Product. TomTom shall not be held responsible for any possible damages, costs or expenses incurred by You related to such removal of a 3D Landmark by TomTom from the Licensed Product or failure to remove a 3D Landmark by You from the Authorized Application.", + "TomTom hereby grants to You a non-exclusive, non-transferable license to use the Software Licensed Products for the sole and limited purpose of assisting You in viewing, analyzing and sectioning the Licensed Products. In no event shall You use the Software Licensed Products to view, analyze, section or in any way manipulate spatial map data that is not provided by TomTom. You shall not derive or attempt to derive the source code of all or any portion of the Licensed Products by reverse engineering, disassembly, decompilation, translation or any other means. You shall affix the following copyright notice on any copy of the GDF Viewer, or any portion of the Licensed Products: “Software ©2011-2020 TomTom North America, Inc. All rights reserved.", + "Neither the Data nor the Licensed Products such as Speed Profiles or TomTom Traffic or any derivatives thereof shall be used for the purpose of enforcement of traffic laws including but not limited to the selection of potential locations for the installation of speed cameras, speed traps or other speed tracking devices. With regards to Speed Profiles, You acknowledge and agrees that the actual speeds may not reflect the legally imposed speed limits.", + "You specifically agree that it shall not: (i) store the data for more than twenty-four (24) hours on Your servers; (ii) broadcast or make Live Services Licensed Products available except to authorized End Users; and (iii) use the feed or information received via the feed for historical data purposes (including but not limited to collection or analysis)." + ] + }, + { + "country": { + "ISO3": "OUP", + "label": "" + }, + "copyrights": [ + "You agree to include as soon as practically possible, but no later than the first new release of the Authorized Application following Your receipt of any 3D Landmarks, any copyright notices related to the display of such landmarks on every Authorized Application and in the “about box” of the Authorized Application. Notwithstanding the aforementioned, TomTom has the right to decide, at its sole discretion, to remove specific 3D Landmarks in subsequent releases of the Licensed Products. In such case, You will remove those 3D Landmarks from the Authorized Application as soon as practically possible, but not later than the first new release of the Authorized Application following Your receipt of the Update to the Licensed Product. TomTom shall not be held responsible for any possible damages, costs or expenses incurred by You related to such removal of a 3D Landmark by TomTom from the Licensed Product or failure to remove a 3D Landmark by You from the Authorized Application.", + "TomTom hereby grants to You a non-exclusive, non-transferable license to use the Software Licensed Products for the sole and limited purpose of assisting You in viewing, analyzing and sectioning the Licensed Products. In no event shall You use the Software Licensed Products to view, analyze, section or in any way manipulate spatial map data that is not provided by TomTom. You shall not derive or attempt to derive the source code of all or any portion of the Licensed Products by reverse engineering, disassembly, decompilation, translation or any other means. You shall affix the following copyright notice on any copy of the GDF Viewer, or any portion of the Licensed Products: “Software ©2011-2020 TomTom North America, Inc. All rights reserved.", + "Neither the Data nor the Licensed Products such as Speed Profiles or TomTom Traffic or any derivatives thereof shall be used for the purpose of enforcement of traffic laws including but not limited to the selection of potential locations for the installation of speed cameras, speed traps or other speed tracking devices. With regards to Speed Profiles, You acknowledge and agrees that the actual speeds may not reflect the legally imposed speed limits.", + "You specifically agree that it shall not: (i) store the data for more than twenty-four (24) hours on Your servers; (ii) broadcast or make Live Services Licensed Products available except to authorized End Users; and (iii) use the feed or information received via the feed for historical data purposes (including but not limited to collection or analysis)." + ] + }, + { + "country": { + "ISO3": "USA", + "label": "United States" + }, + "copyrights": [ + "You agree to include as soon as practically possible, but no later than the first new release of the Authorized Application following Your receipt of any 3D Landmarks, any copyright notices related to the display of such landmarks on every Authorized Application and in the “about box” of the Authorized Application. Notwithstanding the aforementioned, TomTom has the right to decide, at its sole discretion, to remove specific 3D Landmarks in subsequent releases of the Licensed Products. In such case, You will remove those 3D Landmarks from the Authorized Application as soon as practically possible, but not later than the first new release of the Authorized Application following Your receipt of the Update to the Licensed Product. TomTom shall not be held responsible for any possible damages, costs or expenses incurred by You related to such removal of a 3D Landmark by TomTom from the Licensed Product or failure to remove a 3D Landmark by You from the Authorized Application.", + "TomTom hereby grants to You a non-exclusive, non-transferable license to use the Software Licensed Products for the sole and limited purpose of assisting You in viewing, analyzing and sectioning the Licensed Products. In no event shall You use the Software Licensed Products to view, analyze, section or in any way manipulate spatial map data that is not provided by TomTom. You shall not derive or attempt to derive the source code of all or any portion of the Licensed Products by reverse engineering, disassembly, decompilation, translation or any other means. You shall affix the following copyright notice on any copy of the GDF Viewer, or any portion of the Licensed Products: “Software ©2011-2020 TomTom North America, Inc. All rights reserved.", + "Neither the Data nor the Licensed Products such as Speed Profiles or TomTom Traffic or any derivatives thereof shall be used for the purpose of enforcement of traffic laws including but not limited to the selection of potential locations for the installation of speed cameras, speed traps or other speed tracking devices. With regards to Speed Profiles, You acknowledge and agrees that the actual speeds may not reflect the legally imposed speed limits.", + "You specifically agree that it shall not: (i) store the data for more than twenty-four (24) hours on Your servers; (ii) broadcast or make Live Services Licensed Products available except to authorized End Users; and (iii) use the feed or information received via the feed for historical data purposes (including but not limited to collection or analysis).", + "The following copyright notice applies to the use of Post- FSA layer and 6-digit layer: © 1992 – 2021 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection and other intellectual property rights owned or licensed to TomTom. The product includes information copied with permission from Canadian authorities, including © Canada Post Corporation, All rights reserved. The use of this material is subject to the terms of a License Agreement. You will be held liable for any unauthorized copying or disclosure of this material. The following copyright notice applies to the use of Points of Interest: © 1992 – 2021 TomTom. All rights reserved. Portions of the POI database contained in Points of Interest North America have been provided by Neustar Localeze The following copyright notice applies to the use of Telecommunications: © 2021 Pitney Bowes Software Inc. All rights reserved. This product contains information and/or data of iconectiv, licensed to be included herein. Copyright © 2021 iconectiv. All rights reserved. The following copyright notice applies to the use of Logistics: © 1992 – 2021 TomTom. Truck Attribute Data © 2004 - 2021 ProMiles Software Development Corporation. All rights reserved. This material is proprietary and the subject of copyright protection and other intellectual property rights owned or licensed to TomTom.", + "© United States Postal Service 2021", + "You shall not use the Municipal Boundary layer of the Administrative Areas product to create or derive applications which are used by third parties for the purpose of tariff, tax jurisdiction, or tax rate determination for a particular address or range of addresses.", + "This product is built on basis on the following elevation data: SRTM, GTOPO, NED data available from the US Geological Survey: https://lta.cr.usgs.gov/products_overview", + "This product is built on basis on the following elevation data: 2-minute Gridded Global Relief Data (ETOPO2v2) available from U.S. Department of Commerce, National Oceanic and Atmospheric Administration, National Geophysical Data Center: http://www.ngdc.noaa.gov/mgg/fliers/06mgg01.html", + "Contains data made available by City of Everett, WA with the following disclaimer:", + "\"The data made available here has been modified for use from its original source, which is the City of Everett. Neither the City of Everett nor the Information Technology Department makes any claims as to the completeness, timeliness, accuracy or content of any data contained in this application; makes any representation of any kind, including, but not limited to, warranty of the accuracy or fitness for a particular use; nor are any such warranties to be implied or inferred with respect to the information or data furnished herein. The data is subject to change as modifications and updates are complete. It is understood that the information contained in the web feed is being used at one's own risk.\" For specifics, please reference: https://data.everettwa.gov/" + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightForWorld.json b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightForWorld.json new file mode 100644 index 000000000000..7fb3b04be8be --- /dev/null +++ b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightForWorld.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "format": "json" + }, + "responses": { + "200": { + "body": { + "formatVersion": "0.0.1", + "generalCopyrights": [ + "© 1992 - 2022 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection, database right protection and other intellectual property rights owned by TomTom or its suppliers. The use of this material is subject to the terms of a license agreement. Any unauthorized copying or disclosure of this material will lead to criminal and civil liabilities.", + "Data Source © 2022 TomTom", + "based on" + ], + "regions": [ + { + "country": { + "ISO3": "ABW", + "label": "Aruba" + }, + "copyrights": [ + "You agree to include as soon as practically possible, but no later than the first new release of the Authorized Application following Your receipt of any 3D Landmarks, any copyright notices related to the display of such landmarks on every Authorized Application and in the “about box” of the Authorized Application. Notwithstanding the aforementioned, TomTom has the right to decide, at its sole discretion, to remove specific 3D Landmarks in subsequent releases of the Licensed Products. In such case, You will remove those 3D Landmarks from the Authorized Application as soon as practically possible, but not later than the first new release of the Authorized Application following Your receipt of the Update to the Licensed Product. TomTom shall not be held responsible for any possible damages, costs or expenses incurred by You related to such removal of a 3D Landmark by TomTom from the Licensed Product or failure to remove a 3D Landmark by You from the Authorized Application.", + "TomTom hereby grants to You a non-exclusive, non-transferable license to use the Software Licensed Products for the sole and limited purpose of assisting You in viewing, analyzing and sectioning the Licensed Products. In no event shall You use the Software Licensed Products to view, analyze, section or in any way manipulate spatial map data that is not provided by TomTom. You shall not derive or attempt to derive the source code of all or any portion of the Licensed Products by reverse engineering, disassembly, decompilation, translation or any other means. You shall affix the following copyright notice on any copy of the GDF Viewer, or any portion of the Licensed Products: “Software ©2011-2020 TomTom North America, Inc. All rights reserved.", + "Neither the Data nor the Licensed Products such as Speed Profiles or TomTom Traffic or any derivatives thereof shall be used for the purpose of enforcement of traffic laws including but not limited to the selection of potential locations for the installation of speed cameras, speed traps or other speed tracking devices. With regards to Speed Profiles, You acknowledge and agrees that the actual speeds may not reflect the legally imposed speed limits.", + "You specifically agree that it shall not: (i) store the data for more than twenty-four (24) hours on Your servers; (ii) broadcast or make Live Services Licensed Products available except to authorized End Users; and (iii) use the feed or information received via the feed for historical data purposes (including but not limited to collection or analysis)." + ] + }, + "......", + { + "country": { + "ISO3": "ZWE", + "label": "Zimbabwe" + }, + "copyrights": [ + "You agree to include as soon as practically possible, but no later than the first new release of the Authorized Application following Your receipt of any 3D Landmarks, any copyright notices related to the display of such landmarks on every Authorized Application and in the “about box” of the Authorized Application. Notwithstanding the aforementioned, TomTom has the right to decide, at its sole discretion, to remove specific 3D Landmarks in subsequent releases of the Licensed Products. In such case, You will remove those 3D Landmarks from the Authorized Application as soon as practically possible, but not later than the first new release of the Authorized Application following Your receipt of the Update to the Licensed Product. TomTom shall not be held responsible for any possible damages, costs or expenses incurred by You related to such removal of a 3D Landmark by TomTom from the Licensed Product or failure to remove a 3D Landmark by You from the Authorized Application.", + "TomTom hereby grants to You a non-exclusive, non-transferable license to use the Software Licensed Products for the sole and limited purpose of assisting You in viewing, analyzing and sectioning the Licensed Products. In no event shall You use the Software Licensed Products to view, analyze, section or in any way manipulate spatial map data that is not provided by TomTom. You shall not derive or attempt to derive the source code of all or any portion of the Licensed Products by reverse engineering, disassembly, decompilation, translation or any other means. You shall affix the following copyright notice on any copy of the GDF Viewer, or any portion of the Licensed Products: “Software ©2011-2020 TomTom North America, Inc. All rights reserved.", + "Neither the Data nor the Licensed Products such as Speed Profiles or TomTom Traffic or any derivatives thereof shall be used for the purpose of enforcement of traffic laws including but not limited to the selection of potential locations for the installation of speed cameras, speed traps or other speed tracking devices. With regards to Speed Profiles, You acknowledge and agrees that the actual speeds may not reflect the legally imposed speed limits.", + "You specifically agree that it shall not: (i) store the data for more than twenty-four (24) hours on Your servers; (ii) broadcast or make Live Services Licensed Products available except to authorized End Users; and (iii) use the feed or information received via the feed for historical data purposes (including but not limited to collection or analysis)." + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightFromBoundingBox.json b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightFromBoundingBox.json new file mode 100644 index 000000000000..6f1bcbfa9b43 --- /dev/null +++ b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetCopyrightFromBoundingBox.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "format": "json", + "mincoordinates": [ + 52.41064, + 4.84228 + ], + "maxcoordinates": [ + 52.41072, + 4.84239 + ], + "text": "yes" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "formatVersion": "0.0.1", + "generalCopyrights": [ + "© 1992 - 2022 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection, database right protection and other intellectual property rights owned by TomTom or its suppliers. The use of this material is subject to the terms of a license agreement. Any unauthorized copying or disclosure of this material will lead to criminal and civil liabilities.", + "Data Source © 2022 TomTom", + "based on" + ], + "regions": [ + { + "country": { + "ISO3": "NLD", + "label": "Netherlands" + }, + "copyrights": [ + "You agree to include as soon as practically possible, but no later than the first new release of the Authorized Application following Your receipt of any 3D Landmarks, any copyright notices related to the display of such landmarks on every Authorized Application and in the “about box” of the Authorized Application. Notwithstanding the aforementioned, TomTom has the right to decide, at its sole discretion, to remove specific 3D Landmarks in subsequent releases of the Licensed Products. In such case, You will remove those 3D Landmarks from the Authorized Application as soon as practically possible, but not later than the first new release of the Authorized Application following Your receipt of the Update to the Licensed Product. TomTom shall not be held responsible for any possible damages, costs or expenses incurred by You related to such removal of a 3D Landmark by TomTom from the Licensed Product or failure to remove a 3D Landmark by You from the Authorized Application.", + "TomTom hereby grants to You a non-exclusive, non-transferable license to use the Software Licensed Products for the sole and limited purpose of assisting You in viewing, analyzing and sectioning the Licensed Products. In no event shall You use the Software Licensed Products to view, analyze, section or in any way manipulate spatial map data that is not provided by TomTom. You shall not derive or attempt to derive the source code of all or any portion of the Licensed Products by reverse engineering, disassembly, decompilation, translation or any other means. You shall affix the following copyright notice on any copy of the GDF Viewer, or any portion of the Licensed Products: “Software ©2011-2020 TomTom North America, Inc. All rights reserved.", + "Neither the Data nor the Licensed Products such as Speed Profiles or TomTom Traffic or any derivatives thereof shall be used for the purpose of enforcement of traffic laws including but not limited to the selection of potential locations for the installation of speed cameras, speed traps or other speed tracking devices. With regards to Speed Profiles, You acknowledge and agrees that the actual speeds may not reflect the legally imposed speed limits.", + "You specifically agree that it shall not: (i) store the data for more than twenty-four (24) hours on Your servers; (ii) broadcast or make Live Services Licensed Products available except to authorized End Users; and (iii) use the feed or information received via the feed for historical data purposes (including but not limited to collection or analysis).", + "Contains data licensed under CC-BY 4.0. For more information visit: * Kadaster Top10NL http://nationaalgeoregister.nl/geonetwork/srv/dut/catalog.search#/metadata/29d5310f-dd0d-45ba-abad-b4ffc6b8785f?tab=general * Kadaster BGT http://nationaalgeoregister.nl/geonetwork/srv/dut/catalog.search#/metadata/2cb4769c-b56e-48fa-8685-c48f61b9a319?tab=general * CBS Bestand Bodemgebruik http://nationaalgeoregister.nl/geonetwork/srv/dut/catalog.search#/metadata/2d3dd6d2-2d2b-4b5f-9e30-86e19ed77a56?tab=general", + "Contains data licensed under CC-BY 2.0. For more information visit: * Municipality of Amsterdam Datasets Parkeergarages https://data.amsterdam.nl/index.html#?dte=https:%2F%2Fapi.datapunt.amsterdam.nl%2Fcatalogus%2Fapi%2F3%2Faction%2Fpackage_show%3Fid%3Df06f5a77-04f6-432f-9fd9-ce9d740631aa&dtfs=T&mpb=topografie&mpz=9&mpv=52.3719:4.9012", + "Contains data licensed under CC-BY 3.0. For more information visit: * Municipality of Amsterdam Multiple cat POI's https://data.amsterdam.nl/index.html#?dsd=dcatd&dsp=1&dsq=open%2520data&dsv=CATALOG&mpb=topografie&mpz=11&mpv=52.3731081:4.8932945", + "This product contains public transport stops data made available under 9292 Open Data framework as documented on March 2013. This is specified in their terms available here: http://9292opendata.org/sla", + "This product contains traffic incident information made available by NDW under open source data policy: https://www.ndw.nu/pagina/nl/103/datalevering/120/open_data/" + ] + }, + { + "country": { + "ISO3": "ONL", + "label": "" + }, + "copyrights": [ + "You agree to include as soon as practically possible, but no later than the first new release of the Authorized Application following Your receipt of any 3D Landmarks, any copyright notices related to the display of such landmarks on every Authorized Application and in the “about box” of the Authorized Application. Notwithstanding the aforementioned, TomTom has the right to decide, at its sole discretion, to remove specific 3D Landmarks in subsequent releases of the Licensed Products. In such case, You will remove those 3D Landmarks from the Authorized Application as soon as practically possible, but not later than the first new release of the Authorized Application following Your receipt of the Update to the Licensed Product. TomTom shall not be held responsible for any possible damages, costs or expenses incurred by You related to such removal of a 3D Landmark by TomTom from the Licensed Product or failure to remove a 3D Landmark by You from the Authorized Application.", + "TomTom hereby grants to You a non-exclusive, non-transferable license to use the Software Licensed Products for the sole and limited purpose of assisting You in viewing, analyzing and sectioning the Licensed Products. In no event shall You use the Software Licensed Products to view, analyze, section or in any way manipulate spatial map data that is not provided by TomTom. You shall not derive or attempt to derive the source code of all or any portion of the Licensed Products by reverse engineering, disassembly, decompilation, translation or any other means. You shall affix the following copyright notice on any copy of the GDF Viewer, or any portion of the Licensed Products: “Software ©2011-2020 TomTom North America, Inc. All rights reserved.", + "Neither the Data nor the Licensed Products such as Speed Profiles or TomTom Traffic or any derivatives thereof shall be used for the purpose of enforcement of traffic laws including but not limited to the selection of potential locations for the installation of speed cameras, speed traps or other speed tracking devices. With regards to Speed Profiles, You acknowledge and agrees that the actual speeds may not reflect the legally imposed speed limits.", + "You specifically agree that it shall not: (i) store the data for more than twenty-four (24) hours on Your servers; (ii) broadcast or make Live Services Licensed Products available except to authorized End Users; and (iii) use the feed or information received via the feed for historical data purposes (including but not limited to collection or analysis)." + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapAttribution.json b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapAttribution.json new file mode 100644 index 000000000000..a1b49814f030 --- /dev/null +++ b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapAttribution.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "tilesetId": "microsoft.base", + "zoom": 6, + "bounds": [ + -122.414162, + 47.579490, + -122.247157, + 47.668372 + ] + }, + "responses": { + "200": { + "headers": {}, + "body": { + "copyrights": [ + "©2022 TomTom" + ] + } + } + } +} diff --git a/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapStateTile.json b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapStateTile.json new file mode 100644 index 000000000000..950c34ed85da --- /dev/null +++ b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapStateTile.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "statesetId": "[statesetId]", + "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/stable/2024-04-01/examples/Render_GetMapStaticImage.json b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapStaticImage.json new file mode 100644 index 000000000000..dc2cea39e287 --- /dev/null +++ b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapStaticImage.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "zoom": 10, + "center": [ + -122.177621, + 47.613079 + ], + "tilesetId": "microsoft.base.road" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "image/png" + }, + "body": "{file}" + } + } +} diff --git a/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapTile.json b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapTile.json new file mode 100644 index 000000000000..0b6067d66de6 --- /dev/null +++ b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapTile.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "tilesetId": "microsoft.base", + "zoom": 6, + "x": 10, + "y": 22 + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/vnd.mapbox-vector-tile" + }, + "body": "binary image string" + } + } +} diff --git a/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapTileset.json b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapTileset.json new file mode 100644 index 000000000000..e26ae31605d2 --- /dev/null +++ b/specification/maps/data-plane/Render/stable/2024-04-01/examples/Render_GetMapTileset.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-04-01", + "tilesetId": "microsoft.base" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "tilejson": "2.2.0", + "version": "1.0.0", + "attribution": "©2022 TomTom", + "scheme": "xyz", + "tiles": [ + "https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}" + ], + "minzoom": 0, + "maxzoom": 22, + "bounds": [ + -180.0, + -90.0, + 180.0, + 90.0 + ] + } + } + } +} diff --git a/specification/maps/data-plane/Render/stable/2024-04-01/render.json b/specification/maps/data-plane/Render/stable/2024-04-01/render.json new file mode 100644 index 000000000000..9ae21d4b91f8 --- /dev/null +++ b/specification/maps/data-plane/Render/stable/2024-04-01/render.json @@ -0,0 +1,1022 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Render Service", + "version": "2024-04-01", + "description": "Azure Maps Render REST APIs" + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Microsoft Entra OAuth 2.0](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/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 Microsoft Entra ID 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* For more information on Microsoft identity platform, see [Microsoft identity platform overview](https://learn.microsoft.com/entra/identity-platform/v2-overview).", + "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" + }, + "SasToken": { + "type": "apiKey", + "description": "This is a shared access signature token is created from the List SAS operation on the [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 token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", + "name": "SAS Token", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "AzureKey": [] + }, + { + "SasToken": [] + } + ], + "responses": {}, + "parameters": { + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API. Current version is 2024-04-01.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "client" + }, + "BoundingBoxNorthEast": { + "name": "maxcoordinates", + "x-ms-client-name": "northEast", + "in": "query", + "description": "Maximum coordinates (north-east point) of bounding box in latitude longitude coordinate system. E.g. 52.41064,4.84228", + "required": true, + "type": "array", + "items": { + "type": "number", + "format": "double" + }, + "collectionFormat": "csv", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "BoundingBox" + } + }, + "BoundingBoxSouthWest": { + "name": "mincoordinates", + "x-ms-client-name": "southWest", + "in": "query", + "description": "Minimum coordinates (south-west point) of bounding box in latitude longitude coordinate system. E.g. 52.41064,4.84228", + "required": true, + "type": "array", + "items": { + "type": "number", + "format": "double" + }, + "collectionFormat": "csv", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "BoundingBox" + } + }, + "MapTileSize": { + "name": "tileSize", + "in": "query", + "description": "The size of the returned map tile in pixels.", + "type": "string", + "enum": [ + "256", + "512" + ], + "x-ms-enum": { + "name": "MapTileSize", + "modelAsString": true, + "values": [ + { + "value": "256", + "name": "size256", + "description": "Return a 256 by 256 pixel tile." + }, + { + "value": "512", + "name": "size512", + "description": "Return a 512 by 512 pixel tile." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "TilesetId": { + "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/rest/api/maps-creator/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.labels.darkgrey", + "microsoft.base.hybrid.road", + "microsoft.base.hybrid.darkgrey", + "microsoft.imagery", + "microsoft.weather.radar.main", + "microsoft.weather.infrared.main", + "microsoft.traffic.absolute", + "microsoft.traffic.absolute.main", + "microsoft.traffic.relative", + "microsoft.traffic.relative.main", + "microsoft.traffic.relative.dark", + "microsoft.traffic.delay", + "microsoft.traffic.delay.main", + "microsoft.traffic.reduced.main", + "microsoft.traffic.incident" + ], + "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.labels.darkgrey", + "description": "Label data in our dark grey 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.base.hybrid.darkgrey", + "description": "Road, boundary and label data in our dark grey 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. For more information on the Azure Maps Weather service coverage, see [Azure Maps weather services coverage](/azure/azure-maps/weather-coverage). For more information on Radar data, see [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#radar-images).\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. For more information, see [Azure Maps weather services coverage](/azure/azure-maps/weather-coverage). For more information about the satellite data returned, see [Weather services in Azure Maps](/azure-maps/weather-services-concepts#satellite-images).\n\nSupports zoom levels 0 through 15. Format: raster (png)." + }, + { + "value": "microsoft.traffic.absolute", + "description": "absolute traffic tiles in vector" + }, + { + "value": "microsoft.traffic.absolute.main", + "description": "absolute traffic tiles in raster in our main style." + }, + { + "value": "microsoft.traffic.relative", + "description": "relative traffic tiles in vector" + }, + { + "value": "microsoft.traffic.relative.main", + "description": "relative traffic tiles in raster in our main style." + }, + { + "value": "microsoft.traffic.relative.dark", + "description": "relative traffic tiles in raster in our dark style." + }, + { + "value": "microsoft.traffic.delay", + "description": "traffic tiles in vector" + }, + { + "value": "microsoft.traffic.delay.main", + "description": "traffic tiles in raster in our main style" + }, + { + "value": "microsoft.traffic.reduced.main", + "description": "reduced traffic tiles in raster in our main style" + }, + { + "value": "microsoft.traffic.incident", + "description": "incident tiles in vector" + } + ] + }, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/map/tile": { + "get": { + "summary": "Use to request map tiles in vector or raster format.", + "description": "\n\nThe `Get Map Tiles` API in an HTTP GET request that 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](/azure/azure-maps/about-azure-maps#web-sdk)) and [Android SDK](/azure/azure-maps/about-azure-maps#android-sdk).", + "operationId": "Render_GetMapTile", + "x-ms-client-name": "GetMapTile", + "x-ms-examples": { + "Successful Tile Request": { + "$ref": "./examples/Render_GetMapTile.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TilesetId" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/zTileIndex" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/xTileIndex" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/yTileIndex" + }, + { + "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" + }, + { + "$ref": "#/parameters/MapTileSize" + }, + { + "$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": "The tile returned from a successful API call.", + "schema": { + "type": "object", + "format": "file", + "readOnly": true + }, + "headers": { + "Content-Type": { + "type": "string", + "description": "The content-type for the response." + } + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/tileset": { + "get": { + "summary": "Use to get metadata for a tileset.", + "description": "\n\nThe Get Map Tileset API allows users to request metadata for a tileset.", + "operationId": "Render_GetMapTileset", + "x-ms-examples": { + "Successful Tileset Request": { + "$ref": "./examples/Render_GetMapTileset.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TilesetId" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MapTileset" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/attribution": { + "get": { + "summary": "Use to get map copyright attribution information.", + "description": "\n\nThe `Get Map Attribution` API allows users to request map copyright attribution information for a section of a tileset.", + "operationId": "Render_GetMapAttribution", + "x-ms-examples": { + "Successful Attribution Request": { + "$ref": "./examples/Render_GetMapAttribution.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TilesetId" + }, + { + "name": "zoom", + "in": "query", + "description": "Zoom level for the desired map attribution.", + "required": true, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + { + "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": "number", + "format": "double" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MapAttribution" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/statetile": { + "get": { + "summary": "Use to get state tiles in vector format that can then be used to display feature state information in an indoor map.", + "description": "\n\nFetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling. For more information, see [Zoom Levels and Tile Grid](/azure/location-based-services/zoom-levels-and-tile-grid).", + "operationId": "Render_GetMapStateTile", + "x-ms-examples": { + "Successful State Tile Request": { + "$ref": "./examples/Render_GetMapStateTile.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/zTileIndex" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/xTileIndex" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/yTileIndex" + }, + { + "name": "statesetId", + "in": "query", + "description": "The stateset id.", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/vnd.mapbox-vector-tile", + "application/json" + ], + "responses": { + "200": { + "description": "This tile is returned from a successful Get Map State Tile call", + "schema": { + "type": "object", + "format": "file", + "readOnly": true + }, + "headers": { + "Content-Type": { + "type": "string", + "description": "The content-type for the response." + } + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/copyright/caption/{format}": { + "get": { + "summary": "Use to get copyright information to use when rendering a tile.", + "description": "\n\nThe `Get Copyright Caption` API is an HTTP GET request designed to serve copyright information to be used with tiles requested from the Render service. In addition to a basic copyright for the whole map, it can serve specific groups of copyrights for some countries/regions.\n\nAs an alternative to copyrights for map request, it can also return captions for displaying provider information on the map.", + "operationId": "Render_GetCopyrightCaption", + "x-ms-examples": { + "Successful Copyright Caption Request": { + "$ref": "./examples/Render_GetCopyrightCaption.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CopyrightCaption" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/static": { + "get": { + "description": "This rendering API produces static, rasterized map views of a user-defined area. It's suitable for lightweight web applications, when the desired user experience doesn't require interactive map controls, or when bandwidth is limited. This API is also useful for embedding maps in applications outside of the browser, in backend services, report generation, or desktop applications. \n\n This API includes parameters for basic data visualization: \n\n- Labeled pushpins in multiple styles.\n- Render circle, path, and polygon geometry types.\n\nFor more information and detailed examples, see [Render custom data on a raster map](/azure/azure-maps/how-to-render-custom-data).\n

\nThe dimensions of the bbox parameter are constrained, depending on the zoom level. This ensures the resulting image has an appropriate level of detail.\n

\n\n |Zoom Level | Min Lon Range | Max Lon Range | Min Lat Range| Max Lat Range|\n |:----------|:----------------|:----------------|:----------------|:-------------|\n |0 | 56.25 | 360.0 | 30.1105585173 | 180.0 | \n |1 | 28.125 | 360.0 | 14.87468995 | 180.0 |\n |2 | 14.063 | 351.5625 | 7.4130741851 | 137.9576312246 |\n |3 | 7.03125 | 175.78125 | 3.7034501005 | 73.6354071932 |\n |4 | 3.515625 | 87.890625 | 1.8513375155 | 35.4776115315 |\n |5 | 1.7578125 | 43.9453125 | 0.925620264 | 17.4589959239 |\n |6 | 0.87890625 | 21.97265625 | 0.4628040687 | 8.6907788223 |\n |7 | 0.439453125 | 10.986328125 | 0.2314012764 | 4.3404320789 |\n |8 | 0.2197265625 | 5.4931640625 | 0.1157005434 | 2.1695927024 |\n |9 | 0.1098632812 | 2.7465820312 | 0.0578502599 | 1.0847183194 |\n |10 | 0.0549316406 | 1.3732910156 | 0.0289251285 | 0.5423494021 |\n |11 | 0.0274658203 | 0.6866455078 | 0.014462564 | 0.2711734813 |\n |12 | 0.0137329102 | 0.3433227539 | 0.007231282 | 0.1355865882 |\n |13 | 0.0068664551 | 0.171661377 | 0.003615641 | 0.067793275 |\n |14 | 0.0034332275 | 0.0858306885 | 0.0018078205 | 0.0338966351 |\n |15 | 0.0017166138 | 0.0429153442 | 0.0009039102 | 0.0169483173 | \n |16 | 0.0008583069 | 0.0214576721 | 0.0004519551 | 0.0084741586 | \n |17 | 0.0004291534 | 0.0107288361 | 0.0002259776 | 0.0042370793 |\n |18 | 0.0002145767 | 0.005364418 | 0.0001129888 | 0.0021185396 |\n |19 | 0.0001072884 | 0.002682209 | 5.64944E-05 | 0.0010592698 |\n |20 | 5.36442E-05 | 0.0013411045 | 2.82472E-05 | 0.0005296349 | \n\n_Note_ : Either **center** or **bbox** parameter must be supplied to the API.", + "operationId": "Render_GetMapStaticImage", + "x-ms-examples": { + "Successful Static Image Request": { + "$ref": "./examples/Render_GetMapStaticImage.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "tilesetId", + "in": "query", + "description": "Map style to be returned. Possible values are microsoft.base.road, microsoft.base.darkgrey, and microsoft.imagery. Default value is set to be microsoft.base.road. For more information, see [Render TilesetId](https://learn.microsoft.com/en-us/rest/api/maps/render/get-map-tileset?view=rest-maps-2023-06-01&tabs=HTTP#tilesetid).", + "type": "string", + "enum": [ + "microsoft.base.road", + "microsoft.base.darkgrey", + "microsoft.imagery" + ], + "x-ms-enum": { + "name": "TilesetId", + "modelAsString": true, + "values": [ + { + "value": "microsoft.base.road", + "description": "TilesetId contains all layers with rendering main style." + }, + { + "value": "microsoft.base.darkgrey", + "description": "TilesetId contains all layers with our dark grey style." + }, + { + "value": "microsoft.imagery", + "description": "TilesetId contains a combination of satellite and aerial imagery." + } + ] + } + }, + { + "name": "trafficLayer", + "in": "query", + "description": "Optional Value, indicating no traffic flow overlaid on the image result. Possible values are microsoft.traffic.relative.main and none. Default value is none, indicating no traffic flow returned. If traffic related tilesetId is provided, will return map image with corresponding traffic layer. For more information, see [Render TilesetId](https://learn.microsoft.com/en-us/rest/api/maps/render/get-map-tileset?view=rest-maps-2023-06-01&tabs=HTTP#tilesetid).", + "type": "string", + "enum": [ + "microsoft.traffic.relative.main", + "none" + ], + "x-ms-enum": { + "name": "TrafficTilesetId", + "modelAsString": true, + "values": [ + { + "value": "microsoft.traffic.relative.main", + "description": " Supported traffic related tilesetId." + }, + { + "value": "none", + "description": " Default value, no traffic flow overlay." + } + ] + } + }, + { + "name": "zoom", + "in": "query", + "description": "Desired zoom level of the map. Support zoom value range from 0-20 (inclusive) for tilesetId being microsoft.base.road or microsoft.base.darkgrey. Support zoom value range from 0-19 (inclusive) for tilesetId being microsoft.imagery. Default value is 12.

For more information, see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid).", + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 20 + }, + { + "name": "center", + "in": "query", + "description": "Coordinates of the center point in double. Format: 'lon,lat'. Longitude range: -180 to 180. Latitude range: -90 to 90. \n\nNote: Either center or bbox are required parameters. They are\nmutually exclusive.", + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "number", + "format": "double" + } + }, + { + "name": "bbox", + "x-ms-client-name": "boundingBoxPrivate", + "in": "query", + "description": "A bounding box is defined by two latitudes and two longitudes that represent the four sides of a rectangular area on the Earth. Format : 'minLon, minLat,\nmaxLon, maxLat' (in double). \n\nNote: Either bbox or center are required\nparameters. They are mutually exclusive. bbox shouldn’t be used with\nheight or width.\n\nThe maximum and minimum allowed ranges for Lat and Lon are defined for each zoom level\nin the table at the top of this page.", + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "number", + "format": "double" + } + }, + { + "name": "height", + "in": "query", + "description": "Height of the resulting image in pixels. Range from 80 to 1500. Default\nis 512. It shouldn’t be used with bbox.", + "type": "integer", + "format": "int32", + "minimum": 80, + "maximum": 1500 + }, + { + "name": "width", + "in": "query", + "description": "Width of the resulting image in pixels. Range from 80 to 2000. Default is 512. It should not be used with bbox.", + "type": "integer", + "format": "int32", + "minimum": 80, + "maximum": 2000 + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/Language" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/View" + }, + { + "name": "pins", + "description": "Pushpin style and instances. Use this parameter to optionally add pushpins to the image.\nThe pushpin style describes the appearance of the pushpins, and the instances specify\nthe coordinates of the pushpins (in double) and optional labels for each pin. (Be sure to properly URL-encode values of this\nparameter since it will contain reserved characters such as pipes and punctuation.)\n\nThe Azure Maps account S0 SKU only supports a single instance of the pins parameter. Other SKUs\nallow multiple instances of the pins parameter to specify multiple pin styles.\n\nTo render a pushpin at latitude 45°N and longitude 122°W using the default built-in pushpin style, add the\nquerystring parameter \n\n`pins=default||-122 45` \n\nNote that the longitude comes before the latitude.\nAfter URL encoding this will look like\n\n`pins=default%7C%7C-122+45`\n\nAll of the examples here show the pins\nparameter without URL encoding, for clarity.\n\nTo render a pin at multiple locations, separate each location with a pipe character. For example, use\n\n`pins=default||-122 45|-119.5 43.2|-121.67 47.12`\n\nThe S0 Azure Maps account SKU only allows five pushpins. Other account SKUs do not have this limitation.\n\n### Style Modifiers\n\nYou can modify the appearance of the pins by adding style modifiers. These are added after the style but before\nthe locations and labels. Style modifiers each have a two-letter name. These abbreviated names are used to help\nreduce the length of the URL.\n\nTo change the color of the pushpin, use the 'co' style modifier and specify the color using the HTML/CSS RGB color\nformat which is a six-digit hexadecimal number (the three-digit form is not supported). For example, to use\na deep pink color which you would specify as #FF1493 in CSS, use\n\n`pins=default|coFF1493||-122 45`\n\n### Pushpin Labels\n\nTo add a label to the pins, put the label in single quotes just before the coordinates. Avoid using special character such as `|` or `||` in label. For example, to label\nthree pins with the values '1', '2', and '3', use\n\n`pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12`\n\nThere is a built-in pushpin style called 'none' that does not display a pushpin image. You can use this if\nyou want to display labels without any pin image. For example,\n\n`pins=none||'A'-122 45|'B'-119.5 43.2`\n\nTo change the color of the pushpin labels, use the 'lc' label color style modifier. For example, to use pink\npushpins with black labels, use\n\n`pins=default|coFF1493|lc000000||-122 45`\n\nTo change the size of the labels, use the 'ls' label size style modifier. The label size represents the approximate\nheight of the label text in pixels. For example, to increase the label size to 12, use\n\n`pins=default|ls12||'A'-122 45|'B'-119 43`\n\nThe labels are centered at the pushpin 'label anchor.' The anchor location is predefined for built-in pushpins and\nis at the top center of custom pushpins (see below). To override the label anchor, using the 'la' style modifier\nand provide X and Y pixel coordinates for the anchor. These coordinates are relative to the top left corner of the\npushpin image. Positive X values move the anchor to the right, and positive Y values move the anchor down. For example,\nto position the label anchor 10 pixels right and 4 pixels above the top left corner of the pushpin image,\nuse\n\n`pins=default|la10 -4||'A'-122 45|'B'-119 43`\n\n### Custom Pushpins\n\nTo use a custom pushpin image, use the word 'custom' as the pin style name, and then specify a URL after the\nlocation and label information. The maximum allowed size for a customized label image is 65,536 pixels. Use two pipe characters to indicate that you're done specifying locations and are\nstarting the URL. For example,\n\n`pins=custom||-122 45||http://contoso.com/pushpins/red.png`\n\nAfter URL encoding, this would look like\n\n`pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png`\n\nBy default, custom pushpin images are drawn centered at the pin coordinates. This usually isn't ideal as it obscures\nthe location that you're trying to highlight. To override the anchor location of the pin image, use the 'an'\nstyle modifier. This uses the same format as the 'la' label anchor style modifier. For example, if your custom\npin image has the tip of the pin at the top left corner of the image, you can set the anchor to that spot by\nusing\n\n`pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png`\n\nNote: If you use the 'co' color modifier with a custom pushpin image, the specified color will replace the RGB \nchannels of the pixels in the image but will leave the alpha (opacity) channel unchanged. This would usually\nonly be done with a solid-color custom image.\n\n### Scale, Rotation, and Opacity\n\nYou can make pushpins and their labels larger or smaller by using the 'sc' scale style modifier. This is a\nvalue greater than zero. A value of 1 is the standard scale. Values larger than 1 will make the pins larger, and\nvalues smaller than 1 will make them smaller. For example, to draw the pushpins 50% larger than normal, use\n\n`pins=default|sc1.5||-122 45`\n\nYou can rotate pushpins and their labels by using the 'ro' rotation style modifier. This is a number of degrees\nof clockwise rotation. Use a negative number to rotate counter-clockwise. For example, to rotate the pushpins\n90 degrees clockwise and double their size, use\n\n`pins=default|ro90|sc2||-122 45`\n\nYou can make pushpins and their labels partially transparent by specifying the 'al' alpha style modifier.\nThis is a number between 0 and 1 indicating the opacity of the pushpins. Zero makes them completely transparent\n(and not visible) and 1 makes them completely opaque (which is the default). For example, to make pushpins\nand their labels only 67% opaque, use\n\n`pins=default|al.67||-122 45`\n\n### Style Modifier Summary\n\nModifier | Description | Type | Range \n:--------:|---------------|--------|----------\nal | Alpha (opacity) | float | 0 to 1 \nan | Pin anchor | | * \nco | Pin color | string | 000000 to FFFFFF \nla | Label anchor | | * \nlc | Label color | string | 000000 to FFFFFF \nls | Label size | float | Greater than 0 \nro | Rotation | float | -360 to 360 \nsc | Scale | float | Greater than 0 \n\n* X and Y coordinates can be anywhere within pin image or a margin around it.\nThe margin size is the minimum of the pin width and height.", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + } + }, + { + "name": "path", + "description": "Path style and locations (in double). Use this parameter to optionally add lines, polygons or circles to the image.\nThe path style describes the appearance of the line and fill. (Be sure to properly URL-encode values of this\nparameter since it will contain reserved characters such as pipes and punctuation.)\n\nPath parameter is supported in Azure Maps account SKU starting with S1. Multiple instances of the path parameter \nallow to specify multiple geometries with their styles. Number of parameters per request is limited to 10 and\nnumber of locations is limited to 100 per path.\n\nTo render a circle with radius 100 meters and center point at latitude 45°N and longitude 122°W using the default style, add the\nquerystring parameter \n\n`path=ra100||-122 45` \n\nNote that the longitude comes before the latitude.\nAfter URL encoding this will look like\n\n`path=ra100%7C%7C-122+45`\n\nAll of the examples here show the path parameter without URL encoding, for clarity.\n\nTo render a line, separate each location with a pipe character. For example, use\n\n`path=||-122 45|-119.5 43.2|-121.67 47.12`\n\nA polygon is specified with a closed path, where the first and last points are equal. For example, use\n\n`path=||-122 45|-119.5 43.2|-121.67 47.12|-122 45`\n\nLongitude value for locations of lines and polygons can be in the range from -360 to 360 to allow for rendering of geometries crossing the anti-meridian.\n\n### Style Modifiers\n\nYou can modify the appearance of the path by adding style modifiers. These are added before the locations. \nStyle modifiers each have a two-letter name. These abbreviated names are used to help reduce the length\nof the URL.\n\nTo change the color of the outline, use the 'lc' style modifier and specify the color using the HTML/CSS RGB color\nformat which is a six-digit hexadecimal number (the three-digit form is not supported). For example, to use\na deep pink color which you would specify as #FF1493 in CSS, use\n\n`path=lcFF1493||-122 45|-119.5 43.2`\n\nMultiple style modifiers may be combined to create a more complex visual style.\n\n`lc0000FF|lw3|la0.60|fa0.50||-122.2 47.6|-122.2 47.7|-122.3 47.7|-122.3 47.6|-122.2 47.6`\n\n### Style Modifier Summary\n\nModifier | Description | Type | Range \n:--------:|---------------|--------|----------\nlc | Line color | string | 000000 to FFFFFF\nfc | Fill color | string | 000000 to FFFFFF\nla | Line alpha (opacity) | float | 0 to 1 \nfa | Fill alpha (opacity) | float | 0 to 1 \nlw | Line width |int32 | (0, 50] \nra | Circle radius (meters) | float | Greater than 0", + "in": "query", + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + } + }, + { + "name": "Accept", + "in": "header", + "description": "The Accept header field can be used to specify preferences regarding response media types. Allowed media types include image/jpeg and image/png. Return image in image/png if Accept header is not specified.", + "required": false, + "type": "string", + "items": { + "type": "string" + }, + "x-ms-parameter-location": "client", + "enum": [ + "image/png", + "image/jpeg" + ], + "x-ms-enum": { + "name": "MediaType", + "modelAsString": true, + "values": [ + { + "value": "image/png", + "description": "Return image in png format." + }, + { + "value": "image/jpeg", + "description": "Return image in jpeg format." + } + ] + } + } + ], + "produces": [ + "image/jpeg", + "image/png" + ], + "responses": { + "200": { + "description": "This image is returned from a successful Get Map Static Image call.", + "schema": { + "type": "object", + "format": "file", + "readOnly": true + }, + "headers": { + "Content-Type": { + "type": "string", + "description": "The content-type for the response." + } + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/copyright/bounding/{format}": { + "get": { + "summary": "Use to get copyright information for the specified bounding box.", + "description": "\n\nReturns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates", + "operationId": "Render_GetCopyrightFromBoundingBox", + "x-ms-examples": { + "Successful BoundingBox Copyright Request": { + "$ref": "./examples/Render_GetCopyrightFromBoundingBox.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/BoundingBoxSouthWest" + }, + { + "$ref": "#/parameters/BoundingBoxNorthEast" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/IncludeText" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Copyright" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/copyright/tile/{format}": { + "get": { + "summary": "Use to get copyright information.", + "description": "\n\nTo obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates. For more information, see [Zoom Levels and Tile Grid](/azure/azure-maps/zoom-levels-and-tile-grid).\n\nCopyrights API is designed to serve copyright information for Render service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions.", + "operationId": "Render_GetCopyrightForTile", + "x-ms-examples": { + "Successful Tile Copyright Request": { + "$ref": "./examples/Render_GetCopyrightForTile.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/zTileIndex" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/xTileIndex" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/yTileIndex" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/IncludeText" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Copyright" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/map/copyright/world/{format}": { + "get": { + "summary": "Use to get copyright information for for the world.", + "description": "\n\nReturns the copyright information for the world. To obtain the default copyright information for the whole world, don't specify a tile or bounding box. \n\nCopyrights API is designed to serve copyright information for Render service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries/regions. ", + "operationId": "Render_GetCopyrightForWorld", + "x-ms-examples": { + "Successful World Copyright Request": { + "$ref": "./examples/Render_GetCopyrightForWorld.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ResponseFormat" + }, + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/IncludeText" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Copyright" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "Copyright": { + "description": "This object is returned from a successful copyright request", + "type": "object", + "properties": { + "formatVersion": { + "description": "Format Version property", + "type": "string", + "readOnly": true + }, + "generalCopyrights": { + "description": "General Copyrights array", + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "readOnly": true + } + }, + "regions": { + "description": "Regions array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RegionCopyrights" + } + } + } + }, + "CopyrightCaption": { + "description": "This object is returned from a successful copyright call", + "type": "object", + "properties": { + "formatVersion": { + "description": "Format Version property", + "type": "string", + "readOnly": true + }, + "copyrightsCaption": { + "description": "Copyrights Caption property", + "type": "string", + "readOnly": true + } + } + }, + "MapAttribution": { + "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." + } + } + }, + "MapTileset": { + "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": "Describes the version of the TileJSON spec that is implemented by this JSON object." + }, + "name": { + "type": "string", + "description": "A name describing the tileset. The name can contain any legal character. Implementations SHOULD NOT interpret the name as HTML." + }, + "description": { + "type": "string", + "description": "Text description of the tileset. The description can contain any legal character. Implementations SHOULD NOT interpret the description as HTML." + }, + "version": { + "type": "string", + "pattern": "\\d+\\.\\d+\\.\\d+\\w?[\\w\\d]*", + "description": "A semver.org style version number for the tiles contained within the tileset. When changes across tiles are introduced, the minor version MUST change." + }, + "attribution": { + "type": "string", + "description": "Copyright attribution to be displayed on the map. Implementations MAY decide to treat this as HTML or literal text. For security reasons, make absolutely sure that this field can't be abused as a vector for XSS or beacon tracking." + }, + "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. Implementations MAY decide to treat this as HTML or literal text. For security reasons, make absolutely sure that this field can't be abused as a vector for XSS or beacon tracking." + }, + "scheme": { + "type": "string", + "description": "Default: \"xyz\". Either \"xyz\" or \"tms\". Influences the y direction of the tile coordinates. The global-mercator (aka Spherical Mercator) profile is assumed." + }, + "tiles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of tile endpoints. If multiple endpoints are specified, clients may use any combination of endpoints. All endpoints MUST return the same content for the same URL. The array MUST contain at least one endpoint." + }, + "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": { + "x-ms-client-name": "minZoom", + "minimum": 0, + "maximum": 30, + "type": "integer", + "description": "The minimum zoom level." + }, + "maxzoom": { + "x-ms-client-name": "maxZoom", + "minimum": 0, + "maximum": 30, + "type": "integer", + "description": "The maximum zoom level." + }, + "bounds": { + "type": "array", + "items": { + "type": "number" + }, + "description": "The maximum extent of available map tiles. Bounds MUST define an area covered by all zoom levels. The bounds are represented in WGS:84 latitude and longitude values, in the order left, bottom, right, top. Values may be integers or floating point numbers." + }, + "center": { + "type": "array", + "items": { + "type": "number" + }, + "description": "The default location of the tileset in the form [longitude, latitude, zoom]. The zoom level MUST be between minzoom and maxzoom. Implementations can use this value to set the default location." + } + } + }, + "RegionCopyrights": { + "type": "object", + "properties": { + "copyrights": { + "description": "Copyrights array", + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "readOnly": true + } + }, + "country": { + "description": "Country property", + "type": "object", + "readOnly": true, + "properties": { + "ISO3": { + "description": "ISO3 property", + "type": "string", + "readOnly": true + }, + "label": { + "description": "Label property", + "type": "string", + "readOnly": true + } + } + } + } + } + } +}