Skip to content

Commit

Permalink
[Azure Maps] Swagger improvement for Elevation + other minor fixes [H…
Browse files Browse the repository at this point in the history 
…ub Generated] (Azure#16162)

* Add blockchain to latest profile

* Add additional types

* All: Rename CoordinatePair* to LatLongPair*

* Elevation: Assign more descriptive name for point/line request body

* Elevation: Modify descriptions for rows and columns parameters

* Elevation: Use collectionFormat for parameter bounds

* Elevation: Add x-ms-client-flatten to data prop (X: reverted later)

* Elevation: Condense to a single result type for all the methods

* Geolocation: flatten countryRegion prop

* Common: add client name for View parameter

* Search/Weather: Clean up referneces and apiversion

* Elevation: Delete flatten since it's impossible to move array into object

* Elevation: user-friendly key names for x-ms-examples

* Elevation: rename the request body directly instead of using x-ms-client-name

* Elevation: Remove language specific reference

* Common: Remove language specific reference

* Geolocation: Remove language specific reference

* Elevation: rename data property and its type

* Elevation: rename 'endpointsOfPolyline' to simply 'polyline'

* Revert "Geolocation: flatten countryRegion prop"

This reverts commit 2ace329bd9a2442f5b7efb9e25da5e9d7d00bef2.

* Common: Change View's type to enum and modify its client name

Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com>
  • Loading branch information
@alankashiwa @markcowl @LeiWang3
2 people authored and LeiWang3 committed Mar 31, 2022
1 parent 4807a3d commit aadb82e
Show file tree
Hide file tree
Showing 9 changed files with 191 additions and 142 deletions.
115 changes: 107 additions & 8 deletions specification/maps/data-plane/Common/preview/1.0/common.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@
}
}
},
"CoordinatesPair": {
"LatLongPair": {
"description": "A location represented as a latitude and longitude.",
"type": "object",
"properties": {
Expand All @@ -136,7 +136,7 @@
}
}
},
"CoordinatesPairAbbreviated": {
"LatLongPairAbbreviated": {
"description": "A location represented as a latitude and longitude using short names 'lat' & 'lon'.",
"type": "object",
"properties": {
Expand Down Expand Up @@ -532,7 +532,7 @@
"Language": {
"name": "language",
"in": "query",
"description": "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details.",
"description": "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.",
"type": "string",
"x-ms-parameter-location": "method"
},
Expand Down Expand Up @@ -614,16 +614,115 @@
},
"View": {
"name": "view",
"x-ms-client-name": "localizedMapView",
"in": "query",
"description": "The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views.",
"description": "The View parameter (also called the \"user region\" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries have different views of such regions, and the View parameter allows your application to comply with the view required by the country your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views.",
"x-ms-parameter-location": "method",
"type": "string",
"x-ms-parameter-location": "method"
"enum": [
"AE",
"AR",
"BH",
"IN",
"IQ",
"JO",
"KW",
"LB",
"MA",
"OM",
"PK",
"PS",
"QA",
"SA",
"SY",
"YE",
"Auto",
"Unified"
],
"x-ms-enum": {
"name": "LocalizedMapView",
"modelAsString": true,
"values": [
{
"value": "AE",
"description": "United Arab Emirates (Arabic View)"
},
{
"value": "AR",
"description": "Argentina (Argentinian View)"
},
{
"value": "BH",
"description": "Bahrain (Arabic View)"
},
{
"value": "IN",
"description": "India (Indian View)"
},
{
"value": "IQ",
"description": "Iraq (Arabic View)"
},
{
"value": "JO",
"description": "Jordan (Arabic View)"
},
{
"value": "KW",
"description": "Kuwait (Arabic View)"
},
{
"value": "LB",
"description": "Lebanon (Arabic View)"
},
{
"value": "MA",
"description": "Morocco (Moroccan View)"
},
{
"value": "OM",
"description": "Oman (Arabic View)"
},
{
"value": "PK",
"description": "Pakistan (Pakistani View)"
},
{
"value": "PS",
"description": "Palestinian Authority (Arabic View)"
},
{
"value": "QA",
"description": "Qatar (Arabic View)"
},
{
"value": "SA",
"description": "Saudi Arabia (Arabic View)"
},
{
"value": "SY",
"description": "Syria (Arabic View)"
},
{
"value": "YE",
"description": "Yemen (Arabic View)"
},
{
"value": "Auto",
"description": "Return the map data based on the IP address of the request."
},
{
"value": "Unified",
"description": "Unified View (Others)"
}
]
}
},
"xTileIndex": {
"name": "x",
"x-ms-client-name": "xTileIndex",
"in": "query",
"description": "X coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.",
"description": "X coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.",
"required": true,
"type": "integer",
"format": "int32",
Expand All @@ -633,7 +732,7 @@
"name": "y",
"x-ms-client-name": "yTileIndex",
"in": "query",
"description": "Y coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.",
"description": "Y coordinate of the tile on zoom grid. Value must be in the range [0, 2<sup>`zoom`</sup> -1].\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details.",
"required": true,
"type": "integer",
"format": "int32",
Expand Down Expand Up @@ -686,7 +785,7 @@
"x-ms-error-response": true
},
"409StorageLimit": {
"description": "The [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits) is reached on the Azure Maps account. You can always use the [Data Delete API](https://docs.microsoft.com/en-us/rest/api/maps/data/deletepreview) to delete old/unused content and create space for new uploads.",
"description": "The [data storage limit](https://docs.microsoft.com/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits) is reached on the Azure Maps account. You can always use the [Data Delete API](https://docs.microsoft.com/rest/api/maps/data/deletepreview) to delete old/unused content and create space for new uploads.",
"schema": {
"$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse"
},
Expand Down
Loading

0 comments on commit aadb82e

Please sign in to comment.