fix(specs): correct typos is Search API (generated)

algolia/api-clients-automation#3898 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: gazconroy <[email protected]> Co-authored-by: Gary Conroy <[email protected]> Co-authored-by: shortcuts <[email protected]>
algolia · Oct 7, 2024 · cb2a2d2 · cb2a2d2
1 parent 6394c43
commit cb2a2d2
Show file tree

Hide file tree

Showing 192 changed files with 501 additions and 503 deletions.
diff --git a/src/main/scala/algoliasearch/api/SearchClient.scala b/src/main/scala/algoliasearch/api/SearchClient.scala
@@ -161,7 +161,7 @@ class SearchClient(
     * @param objectID
     *   Unique record identifier.
     * @param body
-    *   The record, a schemaless object with attributes that are useful in the context of search and discovery.
+    *   The record. A schemaless object with attributes that are useful in the context of search and discovery.
     */
   def addOrUpdateObject(indexName: String, objectID: String, body: Any, requestOptions: Option[RequestOptions] = None)(
       implicit ec: ExecutionContext
@@ -314,8 +314,8 @@ class SearchClient(
     * proximity, geo distance. Browse requests automatically apply these settings: - `advancedSyntax`: `false` -
     * `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - `distinct`: `false` - `enablePersonalization`:
     * `false` - `enableRules`: `false` - `facets`: `[]` - `getRankingInfo`: `false` - `ignorePlurals`: `false` -
-    * `optionalFilters`: `[]` - `typoTolerance`: `true` or `false` (`min` and `strict` is evaluated to `true`) If you
-    * send these parameters with your browse requests, they'll be ignored.
+    * `optionalFilters`: `[]` - `typoTolerance`: `true` or `false` (`min` and `strict` evaluate to `true`) If you send
+    * these parameters with your browse requests, they'll be ignored.
     *
     * Required API Key ACLs:
     *   - browse
@@ -925,7 +925,7 @@ class SearchClient(
       execute[Seq[Source]](request, requestOptions)
     }
 
-  /** Retrieves a syonym by its ID. To find the object IDs for your synonyms, use the [`search`
+  /** Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the [`search`
     * operation](#tag/Synonyms/operation/searchSynonyms).
     *
     * Required API Key ACLs:
@@ -1153,7 +1153,7 @@ class SearchClient(
     * Related guide: [Copy
     * indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/)
     * **Move** - Moving a source index that doesn't exist is ignored without returning an error. - When moving an index,
-    * the analytics data keep their original name and a new set of analytics data is started for the new name. To access
+    * the analytics data keeps its original name, and a new set of analytics data is started for the new name. To access
     * the original analytics in the dashboard, create an index with the original name. - If the destination index has
     * replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide:
     * [Move
@@ -1182,7 +1182,7 @@ class SearchClient(
     execute[UpdatedAtResponse](request, requestOptions)
   }
 
-  /** Adds new attributes to a record, or update existing ones. - If a record with the specified object ID doesn't
+  /** Adds new attributes to a record, or updates existing ones. - If a record with the specified object ID doesn't
     * exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn't exist yet,
     * this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify
     * a nested attribute, the engine treats it as a replacement for its first-level ancestor. To update an attribute
@@ -1198,10 +1198,10 @@ class SearchClient(
     * the provided value is greater than the current value, and otherwise ignore the whole object update. For example,
     * if you pass an IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, the
     * engine updates the object. If the object doesn't exist yet, the engine only creates it if you pass an IncrementSet
-    * value that's greater than 0. You can specify an operation by providing an object with the attribute to update as
-    * the key and its value being an object with the following properties: - _operation: the operation to apply on the
-    * attribute - value: the right-hand side argument to the operation, for example, increment or decrement step, value
-    * to add or remove.
+    * value greater than 0. You can specify an operation by providing an object with the attribute to update as the key
+    * and its value being an object with the following properties: - _operation: the operation to apply on the attribute
+    * \- value: the right-hand side argument to the operation, for example, increment or decrement step, value to add or
+    * remove.
     *
     * Required API Key ACLs:
     *   - addObject
@@ -1314,7 +1314,7 @@ class SearchClient(
     * @param indexName
     *   Name of the index on which to perform the operation.
     * @param body
-    *   The record, a schemaless object with attributes that are useful in the context of search and discovery.
+    *   The record. A schemaless object with attributes that are useful in the context of search and discovery.
     */
   def saveObject(indexName: String, body: Any, requestOptions: Option[RequestOptions] = None)(implicit
       ec: ExecutionContext
@@ -1467,7 +1467,7 @@ class SearchClient(
     execute[UpdatedAtResponse](request, requestOptions)
   }
 
-  /** Sends multiple search request to one or more indices. This can be useful in these cases: - Different indices for
+  /** Sends multiple search requests to one or more indices. This can be useful in these cases: - Different indices for
     * different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the
     * same index—for example, with different filters.
     *
@@ -1578,7 +1578,7 @@ class SearchClient(
     execute[SearchRulesResponse](request, requestOptions)
   }
 
-  /** Searches a single index and return matching search results (_hits_). This method lets you retrieve up to 1,000
+  /** Searches a single index and returns matching search results (_hits_). This method lets you retrieve up to 1,000
     * hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the
     * `paginatedLimitedTo` index setting.
     *

diff --git a/src/main/scala/algoliasearch/recommend/BaseIndexSettings.scala b/src/main/scala/algoliasearch/recommend/BaseIndexSettings.scala
@@ -37,7 +37,7 @@ import algoliasearch.recommend.SupportedLanguage._
   *   Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/).
   *   Facets are attributes that let you categorize search results. They can be used for filtering search results. By
   *   default, no attribute is used for faceting. Attribute names are case-sensitive. **Modifiers** -
-  *   `filterOnly(\"ATTRIBUTE\")`. Allows using this attribute as a filter, but doesn't evalue the facet values. -
+  *   `filterOnly(\"ATTRIBUTE\")`. Allows the attribute to be used as a filter but doesn't evaluate the facet values. -
   *   `searchable(\"ATTRIBUTE\")`. Allows searching for facet values. - `afterDistinct(\"ATTRIBUTE\")`. Evaluates the
   *   facet count _after_ deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier
   *   to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.
@@ -48,7 +48,7 @@ import algoliasearch.recommend.SupportedLanguage._
   *   offer a different ranking or sorting of your search results, you'll use replica indices. All index operations on a
   *   primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete
   *   set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular,
-  *   standalone index that will no longer by synced with the primary index. **Modifier** - `virtual(\"REPLICA\")`.
+  *   standalone index that will no longer be synced with the primary index. **Modifier** - `virtual(\"REPLICA\")`.
   *   Create a virtual replica, Virtual replicas don't increase the number of records and are optimized for [Relevant
   *   sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/).
   * @param paginationLimitedTo
@@ -102,8 +102,8 @@ import algoliasearch.recommend.SupportedLanguage._
   *   Numeric attributes that can be used as [numerical
   *   filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters).
   *   Attribute names are case-sensitive. By default, all numeric attributes are available as numerical filters. For
-  *   faster indexing, reduce the number of numeric attributes. If you want to turn off filtering for all numeric
-  *   attributes, specifiy an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** -
+  *   faster indexing, reduce the number of numeric attributes. To turn off filtering for all numeric attributes,
+  *   specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** -
   *   `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`.
   * @param separatorsToIndex
   *   Controls which separators are indexed. Separators are all non-letter characters except spaces and currency
@@ -119,8 +119,8 @@ import algoliasearch.recommend.SupportedLanguage._
   *   comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always
   *   unordered. For more information, see [Searchable
   *   attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/).
-  *   **Modifier** - `unordered(\"ATTRIBUTE\")`. Ignore the position of a match within the attribute. Without modifier,
-  *   matches at the beginning of an attribute rank higer than matches at the end.
+  *   **Modifier** - `unordered(\"ATTRIBUTE\")`. Ignore the position of a match within the attribute. Without a
+  *   modifier, matches at the beginning of an attribute rank higher than matches at the end.
   * @param userData
   *   An object with custom data. You can store up to 32kB as custom data.
   * @param customNormalization

diff --git a/src/main/scala/algoliasearch/recommend/BaseRecommendIndexSettings.scala b/src/main/scala/algoliasearch/recommend/BaseRecommendIndexSettings.scala
@@ -132,13 +132,13 @@ import algoliasearch.recommend.SupportedLanguage._
   *   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 dividied by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1
+  *   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).
   * @param disableExactOnAttributes
   *   Searchable attributes for which you want to [turn off the Exact ranking
   *   criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes).
-  *   Attribute names are case-sensitive. This can be useful for attributes with long values, where the likelyhood of an
+  *   Attribute names are case-sensitive. This can be useful for attributes with long values, where the likelihood of an
   *   exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes
   *   favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content
   *   on ranking.
@@ -157,7 +157,7 @@ import algoliasearch.recommend.SupportedLanguage._
   *   even if a synonym matches. For example, with `home` as a synonym for `house` and a search for `home`, records
   *   matching either \"home\" or \"house\" are included in the search results, and either \"home\" or \"house\" are
   *   highlighted. With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records,
-  *   but all occurences of \"house\" are replaced by \"home\" in the highlighted response.
+  *   but all occurrences of \"house\" are replaced by \"home\" in the highlighted response.
   * @param minProximity
   *   Minimum proximity score for two matching words. This adjusts the [Proximity ranking
   *   criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity)

diff --git a/src/main/scala/algoliasearch/recommend/BaseRecommendSearchParams.scala b/src/main/scala/algoliasearch/recommend/BaseRecommendSearchParams.scala
@@ -70,9 +70,9 @@ import algoliasearch.recommend.SupportedLanguage._
   *   the same facet values for the `attributeForDistinct`.
   * @param aroundLatLng
   *   Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only
-  *   records included within circle around this central location are included in the results. The radius of the circle
-  *   is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also
-  *   specify `insidePolygon` or `insideBoundingBox`.
+  *   records included within a circle around this central location are included in the results. The radius of the
+  *   circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you
+  *   also specify `insidePolygon` or `insideBoundingBox`.
   * @param aroundLatLngViaIP
   *   Whether to obtain the coordinates from the request's IP address.
   * @param minimumAroundRadius