Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add deprecation banner to Azure Maps Render V1 #26022

Merged
merged 6 commits into from
Oct 3, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
add summary to all other child pages
miaxzhitong committed Sep 28, 2023

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
commit 5d17ca8bc2ea57c8aaa0a6cd7a8080b0fdd7775b
Original file line number Diff line number Diff line change
@@ -352,6 +352,7 @@
},
"/map/tile/{format}": {
"get": {
"summary": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nFetches map tiles in vector or raster format typically to be integrated into a new map control or SDK. By default, Azure uses vector map tiles for its web map control (see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid))\n\n**Note**: Weather tiles are only available via [Get Map Tile V2 API](https://aka.ms/AzureMapsWeatherTiles). We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2).",
"description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render-v1) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](/rest/api/maps/render-v2) API by 9/17/26.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nFetches map tiles in vector or raster format typically to be integrated into a new map control or SDK. By default, Azure uses vector map tiles for its web map control (see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid))\n\n**Note**: Weather tiles are only available via [Get Map Tile V2 API](https://aka.ms/AzureMapsWeatherTiles). We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2).",
miaxzhitong marked this conversation as resolved.
Show resolved Hide resolved
"operationId": "Render_GetMapTile",
"x-ms-examples": {
@@ -483,6 +484,7 @@
},
"/map/statetile": {
"get": {
"summary": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nFetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling (see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid))",
"description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render-v1) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](/rest/api/maps/render-v2) API by 9/17/26.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nFetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling (see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid))",
"operationId": "Render_GetMapStateTile",
"x-ms-examples": {
@@ -541,6 +543,7 @@
},
"/map/copyright/caption/{format}": {
"get": {
"summary": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nCopyrights API is designed to serve copyright information for Render Tile \nservice. In addition to basic copyright for the whole map, API is serving \nspecific groups of copyrights for some countries.\n\nAs an alternative to copyrights for map request, one can receive captions\nfor displaying the map provider information on the map.",
"description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render-v1) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](/rest/api/maps/render-v2) API by 9/17/26.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nCopyrights API is designed to serve copyright information for Render Tile \nservice. In addition to basic copyright for the whole map, API is serving \nspecific groups of copyrights for some countries.\n\nAs an alternative to copyrights for map request, one can receive captions\nfor displaying the map provider information on the map.",
"operationId": "Render_GetCopyrightCaption",
"x-ms-examples": {
@@ -574,6 +577,7 @@
},
"/map/imagery/{format}": {
"get": {
"summary": "**Applies to**: S0 and S1 pricing tiers.\n\nThis service returns a map image tile with size 256x256, given the x and y coordinates and zoom\nlevel. Zoom level ranges from 1 to 19. The current available style value is 'satellite' which provides satellite\nimagery alone.\n\n\n**Note**: We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2).",
"description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render-v1) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](/rest/api/maps/render-v2) API by 9/17/26.\n\n**Applies to**: S0 and S1 pricing tiers.\n\nThis service returns a map image tile with size 256x256, given the x and y coordinates and zoom\nlevel. Zoom level ranges from 1 to 19. The current available style value is 'satellite' which provides satellite\nimagery alone.\n\n\n**Note**: We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2).",
"operationId": "Render_GetMapImageryTile",
"x-ms-examples": {
@@ -650,6 +654,7 @@
},
"/map/copyright/bounding/{format}": {
"get": {
"summary": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nReturns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates",
"description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render-v1) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](/rest/api/maps/render-v2) API by 9/17/26.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nReturns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates",
"operationId": "Render_GetCopyrightFromBoundingBox",
"x-ms-examples": {
@@ -692,6 +697,7 @@
},
"/map/copyright/tile/{format}": {
"get": {
"summary": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries.\nReturns the copyright information for a given tile. To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates (see: Zoom Levels and Tile Grid).",
"description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render-v1) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](/rest/api/maps/render-v2) API by 9/17/26.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries.\nReturns the copyright information for a given tile. To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates (see: Zoom Levels and Tile Grid).",
"operationId": "Render_GetCopyrightForTile",
"x-ms-examples": {
@@ -737,6 +743,7 @@
},
"/map/copyright/world/{format}": {
"get": {
"summary": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries.\nReturns the copyright information for the world. To obtain the default copyright information for the whole world, do not specify a tile or bounding box.",
"description": "> [!NOTE]\n>\n> **Azure Maps Render v1 service retirement**\n>\n> The Azure Maps [Render v1](/rest/api/maps/render-v1) service is now deprecated and will be retired on 9/17/26. To avoid service disruptions, all calls to Render v1 API will need to be updated to use [Render v2](/rest/api/maps/render-v2) API by 9/17/26.\n\n**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries.\nReturns the copyright information for the world. To obtain the default copyright information for the whole world, do not specify a tile or bounding box.",
"operationId": "Render_GetCopyrightForWorld",
"x-ms-examples": {