Skip to content

Commit 03231a7

Browse files
committed
Common: Change View's type to enum and modify its client name
1 parent cca6b63 commit 03231a7

File tree

1 file changed

+101
-3
lines changed
  • specification/maps/data-plane/Common/preview/1.0

1 file changed

+101
-3
lines changed

specification/maps/data-plane/Common/preview/1.0/common.json

Lines changed: 101 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -614,11 +614,109 @@
614614
},
615615
"View": {
616616
"name": "view",
617-
"x-ms-client-name": "userRegion",
617+
"x-ms-client-name": "localizedMapView",
618618
"in": "query",
619-
"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.",
619+
"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.",
620+
"x-ms-parameter-location": "method",
620621
"type": "string",
621-
"x-ms-parameter-location": "method"
622+
"enum": [
623+
"AE",
624+
"AR",
625+
"BH",
626+
"IN",
627+
"IQ",
628+
"JO",
629+
"KW",
630+
"LB",
631+
"MA",
632+
"OM",
633+
"PK",
634+
"PS",
635+
"QA",
636+
"SA",
637+
"SY",
638+
"YE",
639+
"Auto",
640+
"Unified"
641+
],
642+
"x-ms-enum": {
643+
"name": "LocalizedMapView",
644+
"modelAsString": true,
645+
"values": [
646+
{
647+
"value": "AE",
648+
"description": "United Arab Emirates (Arabic View)"
649+
},
650+
{
651+
"value": "AR",
652+
"description": "Argentina (Argentinian View)"
653+
},
654+
{
655+
"value": "BH",
656+
"description": "Bahrain (Arabic View)"
657+
},
658+
{
659+
"value": "IN",
660+
"description": "India (Indian View)"
661+
},
662+
{
663+
"value": "IQ",
664+
"description": "Iraq (Arabic View)"
665+
},
666+
{
667+
"value": "JO",
668+
"description": "Jordan (Arabic View)"
669+
},
670+
{
671+
"value": "KW",
672+
"description": "Kuwait (Arabic View)"
673+
},
674+
{
675+
"value": "LB",
676+
"description": "Lebanon (Arabic View)"
677+
},
678+
{
679+
"value": "MA",
680+
"description": "Morocco (Moroccan View)"
681+
},
682+
{
683+
"value": "OM",
684+
"description": "Oman (Arabic View)"
685+
},
686+
{
687+
"value": "PK",
688+
"description": "Pakistan (Pakistani View)"
689+
},
690+
{
691+
"value": "PS",
692+
"description": "Palestinian Authority (Arabic View)"
693+
},
694+
{
695+
"value": "QA",
696+
"description": "Qatar (Arabic View)"
697+
},
698+
{
699+
"value": "SA",
700+
"description": "Saudi Arabia (Arabic View)"
701+
},
702+
{
703+
"value": "SY",
704+
"description": "Syria (Arabic View)"
705+
},
706+
{
707+
"value": "YE",
708+
"description": "Yemen (Arabic View)"
709+
},
710+
{
711+
"value": "Auto",
712+
"description": "Return the map data based on the IP address of the request."
713+
},
714+
{
715+
"value": "Unified",
716+
"description": "Unified View (Others)"
717+
}
718+
]
719+
}
622720
},
623721
"xTileIndex": {
624722
"name": "x",

0 commit comments

Comments
 (0)