[Azure Maps] Search fixes (#31753)

* Update RenderingLanguage comment typo * Add SearchLanguage, move part of the code to root namespace * Use new LRO pattern * Add more samples, simplify docstring and update APIs * Update changelog * Change `EnglishUSA` to `EnglishUsa` * Add some sleep in wait for completion for Search LRO API test * Update test cases * Update possible API timing issues * Update auth key location from query to header for Maps SDKs Co-authored-by: Charlie Chen <charlie.chen@microsoft.com>
Azure · Oct 13, 2022 · 5b13d2e · 5b13d2e
1 parent 8900ebd
commit 5b13d2e
Show file tree

Hide file tree

Showing 100 changed files with 3,415 additions and 6,586 deletions.
diff --git a/sdk/maps/Azure.Maps.Geolocation/src/autorest.md b/sdk/maps/Azure.Maps.Geolocation/src/autorest.md
@@ -15,9 +15,6 @@ add-credentials: true
 # at some point those credentials will move away to Swagger according to [this](https://github.com/Azure/autorest/issues/3718)
 credential-default-policy-type: BearerTokenCredentialPolicy
 credential-scopes: https://atlas.microsoft.com/.default
-use-extension:
-  "@autorest/modelerfour": "4.22.3"
-
 generation1-convenience-client: true
 sync-methods: None
 license-header: MICROSOFT_MIT_NO_VERSION
@@ -42,3 +39,8 @@ directive:
   transform: |
     $["azure_auth"] = $["AADToken"];
     delete $["AADToken"];
+- from: swagger-document
+  where: $.securityDefinitions
+  transform: |
+    $["SharedKey"]["in"] = "header";
+```
diff --git a/sdk/maps/Azure.Maps.Rendering/api/Azure.Maps.Rendering.netstandard2.0.cs b/sdk/maps/Azure.Maps.Rendering/api/Azure.Maps.Rendering.netstandard2.0.cs
@@ -271,7 +271,7 @@ public partial class RenderCopyright
         public static Azure.Maps.Rendering.RenderingLanguage EnglishAustralia { get { throw null; } }
         public static Azure.Maps.Rendering.RenderingLanguage EnglishGreatBritain { get { throw null; } }
         public static Azure.Maps.Rendering.RenderingLanguage EnglishNewZealand { get { throw null; } }
-        public static Azure.Maps.Rendering.RenderingLanguage EnglishUSA { get { throw null; } }
+        public static Azure.Maps.Rendering.RenderingLanguage EnglishUsa { get { throw null; } }
         public static Azure.Maps.Rendering.RenderingLanguage Finnish { get { throw null; } }
         public static Azure.Maps.Rendering.RenderingLanguage FrenchFrance { get { throw null; } }
         public static Azure.Maps.Rendering.RenderingLanguage German { get { throw null; } }

diff --git a/sdk/maps/Azure.Maps.Rendering/samples/MapsRenderingTilesImageriesImagesSamples.md b/sdk/maps/Azure.Maps.Rendering/samples/MapsRenderingTilesImageriesImagesSamples.md
@@ -97,7 +97,7 @@ GetMapStaticImageOptions staticImageOptions = new GetMapStaticImageOptions(new G
     MapImageLayer = MapImageLayer.Basic,
     MapImageStyle = MapImageStyle.Dark,
     ZoomLevel = 10,
-    Language = RenderingLanguage.EnglishUSA,
+    Language = RenderingLanguage.EnglishUsa,
 };
 
 // Get static image
@@ -163,7 +163,7 @@ GetMapStaticImageOptions staticImageOptions = new GetMapStaticImageOptions(
     MapImageLayer = MapImageLayer.Basic,
     MapImageStyle = MapImageStyle.Dark,
     ZoomLevel = 10,
-    Language = RenderingLanguage.EnglishUSA
+    Language = RenderingLanguage.EnglishUsa
 };
 
 // Get static image

diff --git a/sdk/maps/Azure.Maps.Rendering/src/Models/RenderingLanguage.cs b/sdk/maps/Azure.Maps.Rendering/src/Models/RenderingLanguage.cs
@@ -1,8 +1,6 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-// <auto-generated/>
-
 #nullable disable
 
 using System;
@@ -31,7 +29,7 @@ public RenderingLanguage(string value)
         private const string EnglishAustraliaValue = "en-AU";
         private const string EnglishGreatBritainValue = "en-GB";
         private const string EnglishNewZealandValue = "en-NZ";
-        private const string EnglishUSAValue = "en-US";
+        private const string EnglishUsaValue = "en-US";
         private const string SpanishSpainValue = "es-ES";
         private const string SpanishMexicoValue = "es-MX";
         private const string FinnishValue = "fi-FI";
@@ -58,12 +56,11 @@ public RenderingLanguage(string value)
         private const string SimplifiedChineseValue = "zh-CN";
         private const string TraditionalChineseValue = "zh-TW";
 
-
         /// <summary> Return Arabic ("ar"). </summary>
         public static RenderingLanguage Arabic { get; } = new RenderingLanguage(ArabicValue);
         /// <summary> Return Bulgarian ("bg-BG"). </summary>
         public static RenderingLanguage Bulgarian { get; } = new RenderingLanguage(BulgarianValue);
-        /// <summary> Return Czech ("ca-CZ"). </summary>
+        /// <summary> Return Czech ("cs-CZ"). </summary>
         public static RenderingLanguage Czech { get; } = new RenderingLanguage(CzechValue);
         /// <summary> Return Danish ("da-DK"). </summary>
         public static RenderingLanguage Danish { get; } = new RenderingLanguage(DanishValue);
@@ -78,7 +75,7 @@ public RenderingLanguage(string value)
         /// <summary> Return English (New Zealand) ("en-NZ"). </summary>
         public static RenderingLanguage EnglishNewZealand { get; } = new RenderingLanguage(EnglishNewZealandValue);
         /// <summary> Return English (USA) ("en-US"). </summary>
-        public static RenderingLanguage EnglishUSA { get; } = new RenderingLanguage(EnglishUSAValue);
+        public static RenderingLanguage EnglishUsa { get; } = new RenderingLanguage(EnglishUsaValue);
         /// <summary> Return Spanish (Spain) ("es-ES"). </summary>
         public static RenderingLanguage SpanishSpain { get; } = new RenderingLanguage(SpanishSpainValue);
         /// <summary> Return Spanish (Mexico) ("es-MX"). </summary>
@@ -95,7 +92,7 @@ public RenderingLanguage(string value)
         public static RenderingLanguage Italian { get; } = new RenderingLanguage(ItalianValue);
         /// <summary> Return Korean ("ko-KR"). </summary>
         public static RenderingLanguage Korean { get; } = new RenderingLanguage(KoreanValue);
-        /// <summary> Return Lithuanian ("l-LT"). </summary>
+        /// <summary> Return Lithuanian ("lt-LT"). </summary>
         public static RenderingLanguage Lithuanian { get; } = new RenderingLanguage(LithuanianValue);
         /// <summary> Return Malay ("ms-MY"). </summary>
         public static RenderingLanguage Malay { get; } = new RenderingLanguage(MalayValue);

diff --git a/sdk/maps/Azure.Maps.Rendering/src/autorest.md b/sdk/maps/Azure.Maps.Rendering/src/autorest.md
@@ -39,4 +39,8 @@ directive:
   transform: |
     $["azure_auth"] = $["AADToken"];
     delete $["AADToken"];
+- from: swagger-document
+  where: $.securityDefinitions
+  transform: |
+    $["SharedKey"]["in"] = "header";
 ```
diff --git a/sdk/maps/Azure.Maps.Rendering/tests/GetMapsTests.cs b/sdk/maps/Azure.Maps.Rendering/tests/GetMapsTests.cs
@@ -35,7 +35,7 @@ public async Task CanGetMapStaticImage()
             {
                 MapImageLayer = MapImageLayer.Basic,
                 MapImageStyle = MapImageStyle.Dark,
-                Language = RenderingLanguage.EnglishUSA,
+                Language = RenderingLanguage.EnglishUsa,
             };
             using var imageStream = new MemoryStream();
             var image = await client.GetMapStaticImageAsync(options);
@@ -81,7 +81,7 @@ public async Task CanGetMapTileSet()
             Assert.AreEqual("1.0.0", tileSet.Value.TileSetVersion);
             Assert.AreEqual("microsoft.imagery", tileSet.Value.TileSetName);
             Assert.AreEqual(1, tileSet.Value.TileEndpoints.Count);
-            Assert.AreEqual(0, tileSet.Value.MinZoomLevel);
+            Assert.AreEqual(1, tileSet.Value.MinZoomLevel);
             Assert.AreEqual(19, tileSet.Value.MaxZoomLevel);
         }
 

diff --git a/sdk/maps/Azure.Maps.Rendering/tests/Samples/RenderingClientSamples.cs b/sdk/maps/Azure.Maps.Rendering/tests/Samples/RenderingClientSamples.cs
@@ -57,7 +57,7 @@ public void RenderingStaticImages()
                 MapImageLayer = MapImageLayer.Basic,
                 MapImageStyle = MapImageStyle.Dark,
                 ZoomLevel = 10,
-                Language = RenderingLanguage.EnglishUSA,
+                Language = RenderingLanguage.EnglishUsa,
             };
 
             // Get static image
@@ -128,7 +128,7 @@ public void RenderingStaticImagesWithPinsAndPaths()
                 MapImageLayer = MapImageLayer.Basic,
                 MapImageStyle = MapImageStyle.Dark,
                 ZoomLevel = 10,
-                Language = RenderingLanguage.EnglishUSA
+                Language = RenderingLanguage.EnglishUsa
             };
 
             // Get static image

diff --git a/sdk/maps/Azure.Maps.Rendering/tests/SessionRecords/GetMapsTests/CanGetMapTileSet.json b/sdk/maps/Azure.Maps.Rendering/tests/SessionRecords/GetMapsTests/CanGetMapTileSet.json
diff --git a/sdk/maps/Azure.Maps.Rendering/tests/SessionRecords/GetMapsTests/CanGetMapTileSetAsync.json b/sdk/maps/Azure.Maps.Rendering/tests/SessionRecords/GetMapsTests/CanGetMapTileSetAsync.json
diff --git a/sdk/maps/Azure.Maps.Routing/README.md b/sdk/maps/Azure.Maps.Routing/README.md
@@ -143,7 +143,7 @@ RouteDirectionOptions options = new RouteDirectionOptions()
     RouteType = RouteType.Fastest,
     UseTrafficData = true,
     TravelMode = TravelMode.Bicycle,
-    Language = RoutingLanguage.EnglishUSA,
+    Language = RoutingLanguage.EnglishUsa,
 };
 
 // Create Route direction query object

diff --git a/sdk/maps/Azure.Maps.Routing/api/Azure.Maps.Routing.netstandard2.0.cs b/sdk/maps/Azure.Maps.Routing/api/Azure.Maps.Routing.netstandard2.0.cs
@@ -291,7 +291,7 @@ public partial class RouteRangeOptions
         public static Azure.Maps.Routing.RoutingLanguage Danish { get { throw null; } }
         public static Azure.Maps.Routing.RoutingLanguage DutchNetherlands { get { throw null; } }
         public static Azure.Maps.Routing.RoutingLanguage EnglishGreatBritain { get { throw null; } }
-        public static Azure.Maps.Routing.RoutingLanguage EnglishUSA { get { throw null; } }
+        public static Azure.Maps.Routing.RoutingLanguage EnglishUsa { get { throw null; } }
         public static Azure.Maps.Routing.RoutingLanguage Finnish { get { throw null; } }
         public static Azure.Maps.Routing.RoutingLanguage FrenchFrance { get { throw null; } }
         public static Azure.Maps.Routing.RoutingLanguage German { get { throw null; } }

diff --git a/sdk/maps/Azure.Maps.Routing/samples/RouteDirectionsSamples.md b/sdk/maps/Azure.Maps.Routing/samples/RouteDirectionsSamples.md
@@ -80,7 +80,7 @@ RouteDirectionOptions options = new RouteDirectionOptions()
     RouteType = RouteType.Fastest,
     UseTrafficData = true,
     TravelMode = TravelMode.Bicycle,
-    Language = RoutingLanguage.EnglishUSA,
+    Language = RoutingLanguage.EnglishUsa,
 };
 
 // Create Route direction query object

diff --git a/sdk/maps/Azure.Maps.Routing/src/MapsRoutingClient.cs b/sdk/maps/Azure.Maps.Routing/src/MapsRoutingClient.cs
@@ -773,6 +773,8 @@ public virtual async Task<GetRouteMatrixOperation> GetRouteMatrixAsync(WaitUntil
                 var operation = new GetRouteMatrixOperation(this, new Uri(response.Headers.Location));
                 if (waitUntil == WaitUntil.Completed)
                 {
+                    // TODO: Remove Thread.Sleep after adding RetryAfterInSeconds parameter
+                    Thread.Sleep(400);
                     await operation.WaitForCompletionAsync(cancellationToken).ConfigureAwait(false);
                 }
 
@@ -868,6 +870,8 @@ public virtual async Task<GetDirectionsOperation> GetDirectionsBatchAsync(WaitUn
                 var operation = new GetDirectionsOperation(this, new Uri(response.Headers.Location));
                 if (waitUntil == WaitUntil.Completed)
                 {
+                    // TODO: Remove Thread.Sleep after adding RetryAfterInSeconds parameter
+                    Thread.Sleep(400);
                     await operation.WaitForCompletionAsync(cancellationToken).ConfigureAwait(false);
                 }
 

diff --git a/sdk/maps/Azure.Maps.Routing/src/Models/RoutingLanguage.cs b/sdk/maps/Azure.Maps.Routing/src/Models/RoutingLanguage.cs
@@ -30,7 +30,7 @@ public RoutingLanguage(string value)
         private const string GermanValue = "de-DE";
         private const string GreekValue = "el-GR";
         private const string EnglishGreatBritainValue = "en-GB";
-        private const string EnglishUSAValue = "en-US";
+        private const string EnglishUsaValue = "en-US";
         private const string SpanishSpainValue = "es-ES";
         private const string SpanishMexicoValue = "es-MX";
         private const string FinnishValue = "fi-FI";
@@ -72,7 +72,7 @@ public RoutingLanguage(string value)
         /// <summary> Return English (Great Britain) ("en-GB"). </summary>
         public static RoutingLanguage EnglishGreatBritain { get; } = new RoutingLanguage(EnglishGreatBritainValue);
         /// <summary> Return English (USA) ("en-US"). </summary>
-        public static RoutingLanguage EnglishUSA { get; } = new RoutingLanguage(EnglishUSAValue);
+        public static RoutingLanguage EnglishUsa { get; } = new RoutingLanguage(EnglishUsaValue);
         /// <summary> Return Spanish (Spain) ("es-ES"). </summary>
         public static RoutingLanguage SpanishSpain { get; } = new RoutingLanguage(SpanishSpainValue);
         /// <summary> Return Spanish (Mexico) ("es-MX"). </summary>

diff --git a/sdk/maps/Azure.Maps.Routing/src/autorest.md b/sdk/maps/Azure.Maps.Routing/src/autorest.md
@@ -15,9 +15,6 @@ add-credentials: true
 # at some point those credentials will move away to Swagger according to [this](https://github.com/Azure/autorest/issues/3718)
 credential-default-policy-type: BearerTokenCredentialPolicy
 credential-scopes: https://atlas.microsoft.com/.default
-use-extension:
-  "@autorest/modelerfour": "4.22.3"
-
 generation1-convenience-client: true
 sync-methods: None
 license-header: MICROSOFT_MIT_NO_VERSION
@@ -40,4 +37,8 @@ directive:
   transform: |
     $["azure_auth"] = $["AADToken"];
     delete $["AADToken"];
+- from: swagger-document
+  where: $.securityDefinitions
+  transform: |
+    $["SharedKey"]["in"] = "header";
 ```
diff --git a/sdk/maps/Azure.Maps.Routing/tests/RouteDirectionsTests.cs b/sdk/maps/Azure.Maps.Routing/tests/RouteDirectionsTests.cs
@@ -85,8 +85,6 @@ public async Task CanRequestRouteDirectionsBatch()
             queries.Add(new RouteDirectionQuery(new List<GeoPosition>() { new GeoPosition(123.751, 45.9375), new GeoPosition(123.767, 45.90625) }));
 
             var operation = await client.GetDirectionsBatchAsync(WaitUntil.Completed, queries);
-            // Sleep 400ms to wait for operation ready
-            Thread.Sleep(400);
             var result = operation.WaitForCompletion();
 
             Assert.AreEqual(2, result.Value.Results.Count);

diff --git a/sdk/maps/Azure.Maps.Routing/tests/Samples/RouteClientSamples.cs b/sdk/maps/Azure.Maps.Routing/tests/Samples/RouteClientSamples.cs
@@ -101,7 +101,7 @@ public void GetRouteDirectionsWithOptions()
                 RouteType = RouteType.Fastest,
                 UseTrafficData = true,
                 TravelMode = TravelMode.Bicycle,
-                Language = RoutingLanguage.EnglishUSA,
+                Language = RoutingLanguage.EnglishUsa,
             };
 
             // Create Route direction query object

diff --git a/sdk/maps/Azure.Maps.Search/CHANGELOG.md b/sdk/maps/Azure.Maps.Search/CHANGELOG.md
@@ -1,15 +1,29 @@
 # Release History
 
-## 1.0.0-beta.2 (Unreleased)
+## 1.0.0-beta.2 (2022-10-11)
 
 ### Features Added
 
+- Add `SearchLanguage`
+
 ### Breaking Changes
 
+- Use new LRO pattern
+- Update some method name
+
 ### Bugs Fixed
 
+- Use nullable for some optional arguments
+
 ### Other Changes
 
+- Add more samples in README
+- Remove net6.0 API view
+- Remove unused files
+- Fix typos
+
 ## 1.0.0-beta.1 (2022-09-06)
 
+### Features Added
+
 - Initial release.