From 9aec5405ff58dc43c5b7c92edcfc51c995e33334 Mon Sep 17 00:00:00 2001
From: CLAWLOR <catherine.lawlor@education.gov.uk>
Date: Mon, 5 Aug 2024 09:40:48 +0100
Subject: [PATCH] add exception info to documented SearchAsync method

---
 .../SearchByKeyword/DefaultSearchByKeywordService.cs     | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/Dfe.Data.Common.Infrastructure.CognitiveSearch/SearchByKeyword/DefaultSearchByKeywordService.cs b/Dfe.Data.Common.Infrastructure.CognitiveSearch/SearchByKeyword/DefaultSearchByKeywordService.cs
index dcd923c..9270832 100644
--- a/Dfe.Data.Common.Infrastructure.CognitiveSearch/SearchByKeyword/DefaultSearchByKeywordService.cs
+++ b/Dfe.Data.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