fix(specs): responseFields description (generated)

algolia/api-clients-automation#4399

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

Author: algolia-bot

src/main/scala/algoliasearch/recommend/BaseRecommendIndexSettings.scala

@@ -156,11 +156,13 @@ import algoliasearch.recommend.SupportedLanguage._
   *   by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
   *   matches with one word between them would have the same score.
   * @param responseFields
-  *   Properties to include in the API response of `search` and `browse` requests. By default, all response properties
-  *   are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
-  *   these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
-  *   any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
-  *   search UI.
+  *   Properties to include in the API response of search and browse requests. By default, all response properties are
+  *   included. To reduce the response size, you can select which properties should be included. An empty list may lead
+  *   to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
+  *   `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
+  *   depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
+  *   on other properties, for example, for pagination. Before restricting the response size, check the impact on your
+  *   search experience.
   * @param maxValuesPerFacet
   *   Maximum number of facet values to return for each facet.
   * @param sortFacetValuesBy

src/main/scala/algoliasearch/recommend/FallbackParams.scala

@@ -360,11 +360,13 @@ import algoliasearch.recommend.SupportedLanguage._
   *   by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
   *   matches with one word between them would have the same score.
   * @param responseFields
-  *   Properties to include in the API response of `search` and `browse` requests. By default, all response properties
-  *   are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
-  *   these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
-  *   any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
-  *   search UI.
+  *   Properties to include in the API response of search and browse requests. By default, all response properties are
+  *   included. To reduce the response size, you can select which properties should be included. An empty list may lead
+  *   to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
+  *   `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
+  *   depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
+  *   on other properties, for example, for pagination. Before restricting the response size, check the impact on your
+  *   search experience.
   * @param maxValuesPerFacet
   *   Maximum number of facet values to return for each facet.
   * @param sortFacetValuesBy

src/main/scala/algoliasearch/recommend/RecommendIndexSettings.scala

@@ -275,11 +275,13 @@ import algoliasearch.recommend.SupportedLanguage._
   *   by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
   *   matches with one word between them would have the same score.
   * @param responseFields
-  *   Properties to include in the API response of `search` and `browse` requests. By default, all response properties
-  *   are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
-  *   these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
-  *   any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
-  *   search UI.
+  *   Properties to include in the API response of search and browse requests. By default, all response properties are
+  *   included. To reduce the response size, you can select which properties should be included. An empty list may lead
+  *   to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
+  *   `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
+  *   depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
+  *   on other properties, for example, for pagination. Before restricting the response size, check the impact on your
+  *   search experience.
   * @param maxValuesPerFacet
   *   Maximum number of facet values to return for each facet.
   * @param sortFacetValuesBy

src/main/scala/algoliasearch/recommend/RecommendSearchParams.scala

@@ -360,11 +360,13 @@ import algoliasearch.recommend.SupportedLanguage._
   *   by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
   *   matches with one word between them would have the same score.
   * @param responseFields
-  *   Properties to include in the API response of `search` and `browse` requests. By default, all response properties
-  *   are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
-  *   these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
-  *   any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
-  *   search UI.
+  *   Properties to include in the API response of search and browse requests. By default, all response properties are
+  *   included. To reduce the response size, you can select which properties should be included. An empty list may lead
+  *   to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
+  *   `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
+  *   depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
+  *   on other properties, for example, for pagination. Before restricting the response size, check the impact on your
+  *   search experience.
   * @param maxValuesPerFacet
   *   Maximum number of facet values to return for each facet.
   * @param sortFacetValuesBy

src/main/scala/algoliasearch/search/BrowseParamsObject.scala

@@ -254,11 +254,13 @@ import algoliasearch.search.SupportedLanguage._
   *   by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
   *   matches with one word between them would have the same score.
   * @param responseFields
-  *   Properties to include in the API response of `search` and `browse` requests. By default, all response properties
-  *   are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
-  *   these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
-  *   any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
-  *   search UI.
+  *   Properties to include in the API response of search and browse requests. By default, all response properties are
+  *   included. To reduce the response size, you can select which properties should be included. An empty list may lead
+  *   to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
+  *   `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
+  *   depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
+  *   on other properties, for example, for pagination. Before restricting the response size, check the impact on your
+  *   search experience.
   * @param maxValuesPerFacet
   *   Maximum number of facet values to return for each facet.
   * @param sortFacetValuesBy

src/main/scala/algoliasearch/search/ConsequenceParams.scala

@@ -252,11 +252,13 @@ import algoliasearch.search.SupportedLanguage._
   *   by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
   *   matches with one word between them would have the same score.
   * @param responseFields
-  *   Properties to include in the API response of `search` and `browse` requests. By default, all response properties
-  *   are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
-  *   these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
-  *   any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
-  *   search UI.
+  *   Properties to include in the API response of search and browse requests. By default, all response properties are
+  *   included. To reduce the response size, you can select which properties should be included. An empty list may lead
+  *   to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
+  *   `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
+  *   depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
+  *   on other properties, for example, for pagination. Before restricting the response size, check the impact on your
+  *   search experience.
   * @param maxValuesPerFacet
   *   Maximum number of facet values to return for each facet.
   * @param sortFacetValuesBy

src/main/scala/algoliasearch/search/IndexSettings.scala

@@ -282,11 +282,13 @@ import algoliasearch.search.SupportedLanguage._
   *   by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
   *   matches with one word between them would have the same score.
   * @param responseFields
-  *   Properties to include in the API response of `search` and `browse` requests. By default, all response properties
-  *   are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
-  *   these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
-  *   any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
-  *   search UI.
+  *   Properties to include in the API response of search and browse requests. By default, all response properties are
+  *   included. To reduce the response size, you can select which properties should be included. An empty list may lead
+  *   to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
+  *   `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
+  *   depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
+  *   on other properties, for example, for pagination. Before restricting the response size, check the impact on your
+  *   search experience.
   * @param maxValuesPerFacet
   *   Maximum number of facet values to return for each facet.
   * @param sortFacetValuesBy

src/main/scala/algoliasearch/search/IndexSettingsAsSearchParams.scala

@@ -163,11 +163,13 @@ import algoliasearch.search.SupportedLanguage._
   *   by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
   *   matches with one word between them would have the same score.
   * @param responseFields
-  *   Properties to include in the API response of `search` and `browse` requests. By default, all response properties
-  *   are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
-  *   these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
-  *   any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
-  *   search UI.
+  *   Properties to include in the API response of search and browse requests. By default, all response properties are
+  *   included. To reduce the response size, you can select which properties should be included. An empty list may lead
+  *   to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
+  *   `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
+  *   depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
+  *   on other properties, for example, for pagination. Before restricting the response size, check the impact on your
+  *   search experience.
   * @param maxValuesPerFacet
   *   Maximum number of facet values to return for each facet.
   * @param sortFacetValuesBy

src/main/scala/algoliasearch/search/SearchForFacets.scala

@@ -257,11 +257,13 @@ import algoliasearch.search.SupportedLanguage._
   *   by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
   *   matches with one word between them would have the same score.
   * @param responseFields
-  *   Properties to include in the API response of `search` and `browse` requests. By default, all response properties
-  *   are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
-  *   these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
-  *   any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
-  *   search UI.
+  *   Properties to include in the API response of search and browse requests. By default, all response properties are
+  *   included. To reduce the response size, you can select which properties should be included. An empty list may lead
+  *   to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
+  *   `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
+  *   depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
+  *   on other properties, for example, for pagination. Before restricting the response size, check the impact on your
+  *   search experience.
   * @param maxValuesPerFacet
   *   Maximum number of facet values to return for each facet.
   * @param sortFacetValuesBy

src/main/scala/algoliasearch/search/SearchForHits.scala

@@ -257,11 +257,13 @@ import algoliasearch.search.SupportedLanguage._
   *   by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
   *   matches with one word between them would have the same score.
   * @param responseFields
-  *   Properties to include in the API response of `search` and `browse` requests. By default, all response properties
-  *   are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
-  *   these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
-  *   any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
-  *   search UI.
+  *   Properties to include in the API response of search and browse requests. By default, all response properties are
+  *   included. To reduce the response size, you can select which properties should be included. An empty list may lead
+  *   to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
+  *   `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
+  *   depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
+  *   on other properties, for example, for pagination. Before restricting the response size, check the impact on your
+  *   search experience.
   * @param maxValuesPerFacet
   *   Maximum number of facet values to return for each facet.
   * @param sortFacetValuesBy

src/main/scala/algoliasearch/search/SearchParamsObject.scala

@@ -254,11 +254,13 @@ import algoliasearch.search.SupportedLanguage._
   *   by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
   *   matches with one word between them would have the same score.
   * @param responseFields
-  *   Properties to include in the API response of `search` and `browse` requests. By default, all response properties
-  *   are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
-  *   these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
-  *   any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
-  *   search UI.
+  *   Properties to include in the API response of search and browse requests. By default, all response properties are
+  *   included. To reduce the response size, you can select which properties should be included. An empty list may lead
+  *   to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
+  *   `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
+  *   depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
+  *   on other properties, for example, for pagination. Before restricting the response size, check the impact on your
+  *   search experience.
   * @param maxValuesPerFacet
   *   Maximum number of facet values to return for each facet.
   * @param sortFacetValuesBy

src/main/scala/algoliasearch/search/SettingsResponse.scala

@@ -282,11 +282,13 @@ import algoliasearch.search.SupportedLanguage._
   *   by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and
   *   matches with one word between them would have the same score.
   * @param responseFields
-  *   Properties to include in the API response of `search` and `browse` requests. By default, all response properties
-  *   are included. To reduce the response size, you can select, which attributes should be included. You can't exclude
-  *   these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or
-  *   any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your
-  *   search UI.
+  *   Properties to include in the API response of search and browse requests. By default, all response properties are
+  *   included. To reduce the response size, you can select which properties should be included. An empty list may lead
+  *   to an empty API response (except properties you can't exclude). You can't exclude these properties: `message`,
+  *   `warning`, `cursor`, `abTestVariantID`, or any property added by setting `getRankingInfo` to true. Your search
+  *   depends on the `hits` field. If you omit this field, searches won't return any results. Your UI might also depend
+  *   on other properties, for example, for pagination. Before restricting the response size, check the impact on your
+  *   search experience.
   * @param maxValuesPerFacet
   *   Maximum number of facet values to return for each facet.
   * @param sortFacetValuesBy