fix(specs): Increase optionalWords visibility in docs (generated)

algolia/api-clients-automation#4559 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: gazconroy <gazconroyster@gmail.com>
algolia · Mar 5, 2025 · 1b6e72b · 1b6e72b
1 parent b2351bf
commit 1b6e72b
Show file tree

Hide file tree

Showing 12 changed files with 61 additions and 41 deletions.
diff --git a/src/main/scala/algoliasearch/api/AbtestingClient.scala b/src/main/scala/algoliasearch/api/AbtestingClient.scala
@@ -110,7 +110,7 @@ class AbtestingClient(
     execute[ABTestResponse](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -133,7 +133,7 @@ class AbtestingClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -156,7 +156,7 @@ class AbtestingClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -183,7 +183,7 @@ class AbtestingClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.

diff --git a/src/main/scala/algoliasearch/api/AnalyticsClient.scala b/src/main/scala/algoliasearch/api/AnalyticsClient.scala
@@ -105,7 +105,7 @@ class AnalyticsClient(
       options = clientOptions
     ) {
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -128,7 +128,7 @@ class AnalyticsClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -151,7 +151,7 @@ class AnalyticsClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -178,7 +178,7 @@ class AnalyticsClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.

diff --git a/src/main/scala/algoliasearch/api/IngestionClient.scala b/src/main/scala/algoliasearch/api/IngestionClient.scala
@@ -284,7 +284,7 @@ class IngestionClient(
     execute[TransformationCreateResponse](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -307,7 +307,7 @@ class IngestionClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -330,7 +330,7 @@ class IngestionClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -357,7 +357,7 @@ class IngestionClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.

diff --git a/src/main/scala/algoliasearch/api/InsightsClient.scala b/src/main/scala/algoliasearch/api/InsightsClient.scala
@@ -85,7 +85,7 @@ class InsightsClient(
       options = clientOptions
     ) {
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -108,7 +108,7 @@ class InsightsClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -131,7 +131,7 @@ class InsightsClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -158,7 +158,7 @@ class InsightsClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.

diff --git a/src/main/scala/algoliasearch/api/MonitoringClient.scala b/src/main/scala/algoliasearch/api/MonitoringClient.scala
@@ -86,7 +86,7 @@ class MonitoringClient(
       options = clientOptions
     ) {
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -109,7 +109,7 @@ class MonitoringClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -132,7 +132,7 @@ class MonitoringClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -159,7 +159,7 @@ class MonitoringClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.

diff --git a/src/main/scala/algoliasearch/api/PersonalizationClient.scala b/src/main/scala/algoliasearch/api/PersonalizationClient.scala
@@ -88,7 +88,7 @@ class PersonalizationClient(
       options = clientOptions
     ) {
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -111,7 +111,7 @@ class PersonalizationClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -134,7 +134,7 @@ class PersonalizationClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -161,7 +161,7 @@ class PersonalizationClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.

diff --git a/src/main/scala/algoliasearch/api/QuerySuggestionsClient.scala b/src/main/scala/algoliasearch/api/QuerySuggestionsClient.scala
@@ -112,7 +112,7 @@ class QuerySuggestionsClient(
     execute[BaseResponse](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -135,7 +135,7 @@ class QuerySuggestionsClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -158,7 +158,7 @@ class QuerySuggestionsClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -185,7 +185,7 @@ class QuerySuggestionsClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.

diff --git a/src/main/scala/algoliasearch/api/RecommendClient.scala b/src/main/scala/algoliasearch/api/RecommendClient.scala
@@ -128,7 +128,7 @@ class RecommendClient(
     execute[RecommendUpdatedAtResponse](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -151,7 +151,7 @@ class RecommendClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -174,7 +174,7 @@ class RecommendClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -201,7 +201,7 @@ class RecommendClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.

diff --git a/src/main/scala/algoliasearch/api/SearchClient.scala b/src/main/scala/algoliasearch/api/SearchClient.scala
@@ -437,7 +437,7 @@ class SearchClient(
     execute[UpdatedAtResponse](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -460,7 +460,7 @@ class SearchClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -483,7 +483,7 @@ class SearchClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.
@@ -510,7 +510,7 @@ class SearchClient(
     execute[T](request, requestOptions)
   }
 
-  /** This method allow you to send requests to the Algolia REST API.
+  /** This method lets you send requests to the Algolia REST API.
     *
     * @param path
     *   Path of the endpoint, anything after \"/1\" must be specified.

diff --git a/src/main/scala/algoliasearch/recommend/OptionalWords.scala b/src/main/scala/algoliasearch/recommend/OptionalWords.scala
@@ -31,7 +31,18 @@ package algoliasearch.recommend
 
 import org.json4s._
 
-/** OptionalWords
+/** Words that should be considered optional when found in the query. By default, records must match all words in the
+  * search query to be included in the search results. Adding optional words can help to increase the number of search
+  * results by running an additional search query that doesn't include the optional words. For example, if the search
+  * query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action
+  * video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more
+  * words **and** all its words are optional, the number of matched words required for a record to be included in the
+  * search results increases for every 1,000 records: - If `optionalWords` has less than 10 words, the required number
+  * of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched
+  * words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of
+  * optional words divided by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1
+  * matched word, results 1,001 to 2000 need 4 matched words. For more information, see [Optional
+  * words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
   */
 sealed trait OptionalWords
 

diff --git a/src/main/scala/algoliasearch/search/Log.scala b/src/main/scala/algoliasearch/search/Log.scala
@@ -33,8 +33,6 @@
   */
 package algoliasearch.search
 
-import java.net.URI
-
 import org.json4s._
 
 /** Log
@@ -76,7 +74,7 @@ case class Log(
     answerCode /* answer_code */: String,
     queryBody /* query_body */: String,
     answer: String,
-    url: URI,
+    url: String,
     ip: String,
     queryHeaders /* query_headers */: String,
     sha1: String,

diff --git a/src/main/scala/algoliasearch/search/OptionalWords.scala b/src/main/scala/algoliasearch/search/OptionalWords.scala
@@ -35,7 +35,18 @@ package algoliasearch.search
 
 import org.json4s._
 
-/** OptionalWords
+/** Words that should be considered optional when found in the query. By default, records must match all words in the
+  * search query to be included in the search results. Adding optional words can help to increase the number of search
+  * results by running an additional search query that doesn't include the optional words. For example, if the search
+  * query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action
+  * video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more
+  * words **and** all its words are optional, the number of matched words required for a record to be included in the
+  * search results increases for every 1,000 records: - If `optionalWords` has less than 10 words, the required number
+  * of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched
+  * words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of
+  * optional words divided by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1
+  * matched word, results 1,001 to 2000 need 4 matched words. For more information, see [Optional
+  * words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
   */
 sealed trait OptionalWords