fix(specs): extend Analytics descriptions (generated)

algolia/api-clients-automation#4360

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: gazconroy <[email protected]>
Co-authored-by: Gary Conroy <[email protected]>
Co-authored-by: Kai Welke <[email protected]>

Author: 4 people

src/main/scala/algoliasearch/analytics/ClickPosition.scala

@@ -13,9 +13,14 @@
   * parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII
   * characters must be UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. ## Response status and errors The
   * Analytics API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of
-  * attributes in the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status.
+  * attributes in the API response. - Successful responses return a `2xx` status - Client errors return a `4xx` status -
   * Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information. ##
-  * Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL.
+  * Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL. ##
+  * Query aggregation Algolia accepts queries on each keystroke. To ensure you have relevant analytics data, however,
+  * the series of keystrokes is aggregated to keep only the latest (final) user query. This is called \"prefix\"
+  * aggregation. For more information, see [Query agggregation and
+  * processing](https://www.algolia.com/doc/guides/search-analytics/concepts/query-aggregation/). See the analytics
+  * implementation overview for more information about query aggregation.
   *
   * The version of the OpenAPI document: 2.0.0
   *

src/main/scala/algoliasearch/analytics/CurrencyCode.scala

@@ -13,9 +13,14 @@
   * parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII
   * characters must be UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. ## Response status and errors The
   * Analytics API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of
-  * attributes in the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status.
+  * attributes in the API response. - Successful responses return a `2xx` status - Client errors return a `4xx` status -
   * Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information. ##
-  * Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL.
+  * Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL. ##
+  * Query aggregation Algolia accepts queries on each keystroke. To ensure you have relevant analytics data, however,
+  * the series of keystrokes is aggregated to keep only the latest (final) user query. This is called \"prefix\"
+  * aggregation. For more information, see [Query agggregation and
+  * processing](https://www.algolia.com/doc/guides/search-analytics/concepts/query-aggregation/). See the analytics
+  * implementation overview for more information about query aggregation.
   *
   * The version of the OpenAPI document: 2.0.0
   *

src/main/scala/algoliasearch/analytics/DailyAddToCartRates.scala

@@ -13,9 +13,14 @@
   * parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII
   * characters must be UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. ## Response status and errors The
   * Analytics API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of
-  * attributes in the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status.
+  * attributes in the API response. - Successful responses return a `2xx` status - Client errors return a `4xx` status -
   * Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information. ##
-  * Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL.
+  * Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL. ##
+  * Query aggregation Algolia accepts queries on each keystroke. To ensure you have relevant analytics data, however,
+  * the series of keystrokes is aggregated to keep only the latest (final) user query. This is called \"prefix\"
+  * aggregation. For more information, see [Query agggregation and
+  * processing](https://www.algolia.com/doc/guides/search-analytics/concepts/query-aggregation/). See the analytics
+  * implementation overview for more information about query aggregation.
   *
   * The version of the OpenAPI document: 2.0.0
   *
@@ -27,7 +32,7 @@ package algoliasearch.analytics
 /** DailyAddToCartRates
   *
   * @param rate
-  *   Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the
+  *   Add-to-cart rate: calculated as the number of tracked searches with at least one add-to-cart event divided by the
   *   number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
   * @param trackedSearchCount
   *   Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.

src/main/scala/algoliasearch/analytics/DailyAverageClicks.scala

@@ -13,9 +13,14 @@
   * parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII
   * characters must be UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. ## Response status and errors The
   * Analytics API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of
-  * attributes in the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status.
+  * attributes in the API response. - Successful responses return a `2xx` status - Client errors return a `4xx` status -
   * Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information. ##
-  * Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL.
+  * Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL. ##
+  * Query aggregation Algolia accepts queries on each keystroke. To ensure you have relevant analytics data, however,
+  * the series of keystrokes is aggregated to keep only the latest (final) user query. This is called \"prefix\"
+  * aggregation. For more information, see [Query agggregation and
+  * processing](https://www.algolia.com/doc/guides/search-analytics/concepts/query-aggregation/). See the analytics
+  * implementation overview for more information about query aggregation.
   *
   * The version of the OpenAPI document: 2.0.0
   *

src/main/scala/algoliasearch/analytics/DailyClickThroughRates.scala

@@ -13,9 +13,14 @@
   * parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII
   * characters must be UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. ## Response status and errors The
   * Analytics API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of
-  * attributes in the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status.
+  * attributes in the API response. - Successful responses return a `2xx` status - Client errors return a `4xx` status -
   * Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information. ##
-  * Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL.
+  * Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL. ##
+  * Query aggregation Algolia accepts queries on each keystroke. To ensure you have relevant analytics data, however,
+  * the series of keystrokes is aggregated to keep only the latest (final) user query. This is called \"prefix\"
+  * aggregation. For more information, see [Query agggregation and
+  * processing](https://www.algolia.com/doc/guides/search-analytics/concepts/query-aggregation/). See the analytics
+  * implementation overview for more information about query aggregation.
   *
   * The version of the OpenAPI document: 2.0.0
   *
@@ -27,8 +32,8 @@ package algoliasearch.analytics
 /** DailyClickThroughRates
   *
   * @param rate
-  *   Click-through rate, calculated as number of tracked searches with at least one click event divided by the number
-  *   of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
+  *   Click-through rate: calculated as the number of tracked searches with at least one click event divided by the
+  *   number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
   * @param clickCount
   *   Number of clicks associated with this search.
   * @param trackedSearchCount

src/main/scala/algoliasearch/analytics/DailyConversionRates.scala

@@ -13,9 +13,14 @@
   * parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII
   * characters must be UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. ## Response status and errors The
   * Analytics API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of
-  * attributes in the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status.
+  * attributes in the API response. - Successful responses return a `2xx` status - Client errors return a `4xx` status -
   * Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information. ##
-  * Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL.
+  * Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL. ##
+  * Query aggregation Algolia accepts queries on each keystroke. To ensure you have relevant analytics data, however,
+  * the series of keystrokes is aggregated to keep only the latest (final) user query. This is called \"prefix\"
+  * aggregation. For more information, see [Query agggregation and
+  * processing](https://www.algolia.com/doc/guides/search-analytics/concepts/query-aggregation/). See the analytics
+  * implementation overview for more information about query aggregation.
   *
   * The version of the OpenAPI document: 2.0.0
   *
@@ -27,8 +32,8 @@ package algoliasearch.analytics
 /** DailyConversionRates
   *
   * @param rate
-  *   Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number
-  *   of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
+  *   Conversion rate: calculated as the number of tracked searches with at least one conversion event divided by the
+  *   number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
   * @param trackedSearchCount
   *   Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
   * @param conversionCount

src/main/scala/algoliasearch/analytics/DailyNoClickRates.scala

@@ -13,9 +13,14 @@
   * parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII
   * characters must be UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. ## Response status and errors The
   * Analytics API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of
-  * attributes in the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status.
+  * attributes in the API response. - Successful responses return a `2xx` status - Client errors return a `4xx` status -
   * Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information. ##
-  * Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL.
+  * Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL. ##
+  * Query aggregation Algolia accepts queries on each keystroke. To ensure you have relevant analytics data, however,
+  * the series of keystrokes is aggregated to keep only the latest (final) user query. This is called \"prefix\"
+  * aggregation. For more information, see [Query agggregation and
+  * processing](https://www.algolia.com/doc/guides/search-analytics/concepts/query-aggregation/). See the analytics
+  * implementation overview for more information about query aggregation.
   *
   * The version of the OpenAPI document: 2.0.0
   *
@@ -27,7 +32,7 @@ package algoliasearch.analytics
 /** DailyNoClickRates
   *
   * @param rate
-  *   No click rate, calculated as number of tracked searches without any click divided by the number of tracked
+  *   No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked
   *   searches.
   * @param count
   *   Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.

src/main/scala/algoliasearch/analytics/DailyNoResultsRates.scala

@@ -13,9 +13,14 @@
   * parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII
   * characters must be UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. ## Response status and errors The
   * Analytics API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of
-  * attributes in the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status.
+  * attributes in the API response. - Successful responses return a `2xx` status - Client errors return a `4xx` status -
   * Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information. ##
-  * Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL.
+  * Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL. ##
+  * Query aggregation Algolia accepts queries on each keystroke. To ensure you have relevant analytics data, however,
+  * the series of keystrokes is aggregated to keep only the latest (final) user query. This is called \"prefix\"
+  * aggregation. For more information, see [Query agggregation and
+  * processing](https://www.algolia.com/doc/guides/search-analytics/concepts/query-aggregation/). See the analytics
+  * implementation overview for more information about query aggregation.
   *
   * The version of the OpenAPI document: 2.0.0
   *
@@ -33,7 +38,7 @@ package algoliasearch.analytics
   * @param count
   *   Number of searches.
   * @param rate
-  *   No results rate, calculated as number of searches with zero results divided by the total number of searches.
+  *   No results rate: calculated as the number of searches with zero results divided by the total number of searches.
   */
 case class DailyNoResultsRates(
     date: String,

src/main/scala/algoliasearch/analytics/DailyPurchaseRates.scala

@@ -13,9 +13,14 @@
   * parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII
   * characters must be UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. ## Response status and errors The
   * Analytics API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of
-  * attributes in the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status.
+  * attributes in the API response. - Successful responses return a `2xx` status - Client errors return a `4xx` status -
   * Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information. ##
-  * Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL.
+  * Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL. ##
+  * Query aggregation Algolia accepts queries on each keystroke. To ensure you have relevant analytics data, however,
+  * the series of keystrokes is aggregated to keep only the latest (final) user query. This is called \"prefix\"
+  * aggregation. For more information, see [Query agggregation and
+  * processing](https://www.algolia.com/doc/guides/search-analytics/concepts/query-aggregation/). See the analytics
+  * implementation overview for more information about query aggregation.
   *
   * The version of the OpenAPI document: 2.0.0
   *
@@ -27,8 +32,8 @@ package algoliasearch.analytics
 /** DailyPurchaseRates
   *
   * @param rate
-  *   Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of
-  *   tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
+  *   Purchase rate: calculated as the number of tracked searches with at least one purchase event divided by the number
+  *   of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
   * @param trackedSearchCount
   *   Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
   * @param purchaseCount

src/main/scala/algoliasearch/analytics/DailyRevenue.scala

@@ -13,9 +13,14 @@
   * parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII
   * characters must be UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. ## Response status and errors The
   * Analytics API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of
-  * attributes in the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status.
+  * attributes in the API response. - Successful responses return a `2xx` status - Client errors return a `4xx` status -
   * Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information. ##
-  * Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL.
+  * Version The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL. ##
+  * Query aggregation Algolia accepts queries on each keystroke. To ensure you have relevant analytics data, however,
+  * the series of keystrokes is aggregated to keep only the latest (final) user query. This is called \"prefix\"
+  * aggregation. For more information, see [Query agggregation and
+  * processing](https://www.algolia.com/doc/guides/search-analytics/concepts/query-aggregation/). See the analytics
+  * implementation overview for more information about query aggregation.
   *
   * The version of the OpenAPI document: 2.0.0
   *
@@ -27,7 +32,7 @@ package algoliasearch.analytics
 /** DailyRevenue
   *
   * @param currencies
-  *   Revenue associated with this search, broken-down by currencies.
+  *   Revenue associated with this search: broken down by currency.
   * @param date
   *   Date in the format YYYY-MM-DD.
   */