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

algolia/api-clients-automation#4559

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: gazconroy <[email protected]>

Author: algolia-bot

client/src/commonMain/kotlin/com/algolia/client/api/AbtestingClient.kt

@@ -50,7 +50,7 @@ public class AbtestingClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param requestOptions additional request configuration.
@@ -71,7 +71,7 @@ public class AbtestingClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param requestOptions additional request configuration.
@@ -92,7 +92,7 @@ public class AbtestingClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param body Parameters to send with the custom request.
@@ -115,7 +115,7 @@ public class AbtestingClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param body Parameters to send with the custom request.

client/src/commonMain/kotlin/com/algolia/client/api/AnalyticsClient.kt

@@ -30,7 +30,7 @@ public class AnalyticsClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param requestOptions additional request configuration.
@@ -51,7 +51,7 @@ public class AnalyticsClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param requestOptions additional request configuration.
@@ -72,7 +72,7 @@ public class AnalyticsClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param body Parameters to send with the custom request.
@@ -95,7 +95,7 @@ public class AnalyticsClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param body Parameters to send with the custom request.

client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt

@@ -147,7 +147,7 @@ public class IngestionClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param requestOptions additional request configuration.
@@ -168,7 +168,7 @@ public class IngestionClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param requestOptions additional request configuration.
@@ -189,7 +189,7 @@ public class IngestionClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param body Parameters to send with the custom request.
@@ -212,7 +212,7 @@ public class IngestionClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param body Parameters to send with the custom request.

client/src/commonMain/kotlin/com/algolia/client/api/InsightsClient.kt

@@ -30,7 +30,7 @@ public class InsightsClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param requestOptions additional request configuration.
@@ -51,7 +51,7 @@ public class InsightsClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param requestOptions additional request configuration.
@@ -72,7 +72,7 @@ public class InsightsClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param body Parameters to send with the custom request.
@@ -95,7 +95,7 @@ public class InsightsClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param body Parameters to send with the custom request.

client/src/commonMain/kotlin/com/algolia/client/api/MonitoringClient.kt

@@ -28,7 +28,7 @@ public class MonitoringClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param requestOptions additional request configuration.
@@ -49,7 +49,7 @@ public class MonitoringClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param requestOptions additional request configuration.
@@ -70,7 +70,7 @@ public class MonitoringClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param body Parameters to send with the custom request.
@@ -93,7 +93,7 @@ public class MonitoringClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param body Parameters to send with the custom request.

client/src/commonMain/kotlin/com/algolia/client/api/PersonalizationClient.kt

@@ -30,7 +30,7 @@ public class PersonalizationClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param requestOptions additional request configuration.
@@ -51,7 +51,7 @@ public class PersonalizationClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param requestOptions additional request configuration.
@@ -72,7 +72,7 @@ public class PersonalizationClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param body Parameters to send with the custom request.
@@ -95,7 +95,7 @@ public class PersonalizationClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param body Parameters to send with the custom request.

client/src/commonMain/kotlin/com/algolia/client/api/QuerySuggestionsClient.kt

@@ -50,7 +50,7 @@ public class QuerySuggestionsClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param requestOptions additional request configuration.
@@ -71,7 +71,7 @@ public class QuerySuggestionsClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param requestOptions additional request configuration.
@@ -92,7 +92,7 @@ public class QuerySuggestionsClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param body Parameters to send with the custom request.
@@ -115,7 +115,7 @@ public class QuerySuggestionsClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param body Parameters to send with the custom request.

client/src/commonMain/kotlin/com/algolia/client/api/RecommendClient.kt

@@ -56,7 +56,7 @@ public class RecommendClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param requestOptions additional request configuration.
@@ -77,7 +77,7 @@ public class RecommendClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param requestOptions additional request configuration.
@@ -98,7 +98,7 @@ public class RecommendClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param body Parameters to send with the custom request.
@@ -121,7 +121,7 @@ public class RecommendClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param body Parameters to send with the custom request.

client/src/commonMain/kotlin/com/algolia/client/api/SearchClient.kt

@@ -279,7 +279,7 @@ public class SearchClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param requestOptions additional request configuration.
@@ -300,7 +300,7 @@ public class SearchClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param requestOptions additional request configuration.
@@ -321,7 +321,7 @@ public class SearchClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param body Parameters to send with the custom request.
@@ -344,7 +344,7 @@ public class SearchClient(
   }
 
   /**
-   * 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.
    * @param parameters Query parameters to apply to the current query.
    * @param body Parameters to send with the custom request.

client/src/commonMain/kotlin/com/algolia/client/model/recommend/OptionalWords.kt

@@ -11,7 +11,7 @@ import kotlinx.serialization.json.*
 import kotlin.jvm.JvmInline
 
 /**
- * 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).
  *
  * Implementations:
  * - [List<String>] - *[OptionalWords.of]*