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

algoliasearch/src/main/java/com/algolia/model/recommend/FallbackParams.java

@@ -1722,11 +1722,14 @@ public FallbackParams addResponseFields(String responseFieldsItem) {
   }
 
   /**
-   * 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.
    */
   @javax.annotation.Nullable
   public List<String> getResponseFields() {

algoliasearch/src/main/java/com/algolia/model/recommend/RecommendSearchParams.java

@@ -1722,11 +1722,14 @@ public RecommendSearchParams addResponseFields(String responseFieldsItem) {
   }
 
   /**
-   * 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.
    */
   @javax.annotation.Nullable
   public List<String> getResponseFields() {

algoliasearch/src/main/java/com/algolia/model/search/BrowseParamsObject.java

@@ -1300,11 +1300,14 @@ public BrowseParamsObject addResponseFields(String responseFieldsItem) {
   }
 
   /**
-   * 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.
    */
   @javax.annotation.Nullable
   public List<String> getResponseFields() {

algoliasearch/src/main/java/com/algolia/model/search/ConsequenceParams.java

@@ -1291,11 +1291,14 @@ public ConsequenceParams addResponseFields(String responseFieldsItem) {
   }
 
   /**
-   * 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.
    */
   @javax.annotation.Nullable
   public List<String> getResponseFields() {

algoliasearch/src/main/java/com/algolia/model/search/IndexSettings.java

@@ -1228,11 +1228,14 @@ public IndexSettings addResponseFields(String responseFieldsItem) {
   }
 
   /**
-   * 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.
    */
   @javax.annotation.Nullable
   public List<String> getResponseFields() {

algoliasearch/src/main/java/com/algolia/model/search/SearchForFacets.java

@@ -1326,11 +1326,14 @@ public SearchForFacets addResponseFields(String responseFieldsItem) {
   }
 
   /**
-   * 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.
    */
   @javax.annotation.Nullable
   public List<String> getResponseFields() {

algoliasearch/src/main/java/com/algolia/model/search/SearchForHits.java

@@ -1317,11 +1317,14 @@ public SearchForHits addResponseFields(String responseFieldsItem) {
   }
 
   /**
-   * 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.
    */
   @javax.annotation.Nullable
   public List<String> getResponseFields() {

algoliasearch/src/main/java/com/algolia/model/search/SearchParamsObject.java

@@ -1297,11 +1297,14 @@ public SearchParamsObject addResponseFields(String responseFieldsItem) {
   }
 
   /**
-   * 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.
    */
   @javax.annotation.Nullable
   public List<String> getResponseFields() {

algoliasearch/src/main/java/com/algolia/model/search/SettingsResponse.java

@@ -1231,11 +1231,14 @@ public SettingsResponse addResponseFields(String responseFieldsItem) {
   }
 
   /**
-   * 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.
    */
   @javax.annotation.Nullable
   public List<String> getResponseFields() {