Merge pull request #1 from DFE-Digital/CL/update-comments

add exception info to documented SearchAsync method
DFE-Digital · Aug 5, 2024 · d2b2b8f · d2b2b8f
2 parents 679df09 + 9aec540
commit d2b2b8f
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/...ta.Common.Infrastructure.CognitiveSearch/SearchByKeyword/DefaultSearchByKeywordService.cs b/...ta.Common.Infrastructure.CognitiveSearch/SearchByKeyword/DefaultSearchByKeywordService.cs
@@ -54,6 +54,15 @@ public DefaultSearchByKeywordService(
     /// <returns>
     /// The response containing search results from an index.
     /// </returns>
+    /// <exception cref="ArgumentException">
+    /// Thrown when the param <paramref name="searchKeyword"/> or the param <paramref name="searchIndex"/> are null or empty
+    /// </exception>
+    /// <exception cref="ArgumentNullException">
+    /// Thrown when the param <paramref name="searchOptions"/>is null
+    /// </exception>
+    /// <exception cref="RequestFailedException">
+    /// Thrown when a failure is returned by the Azure Search Service
+    /// </exception>
     public Task<Response<SearchResults<TSearchResult>>> SearchAsync<TSearchResult>(
         string searchKeyword, string searchIndex, SearchOptions searchOptions)
         where TSearchResult : class