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

Sources/Recommend/Models/BaseRecommendIndexSettings.swift

@@ -120,11 +120,13 @@ public struct BaseRecommendIndexSettings: Codable, JSONEncodable {
     /// 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.
     public var minProximity: Int?
-    /// 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.
     public var responseFields: [String]?
     /// Maximum number of facet values to return for each facet.
     public var maxValuesPerFacet: Int?

Sources/Recommend/Models/FallbackParams.swift

@@ -315,11 +315,13 @@ public struct FallbackParams: Codable, JSONEncodable {
     /// 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.
     public var minProximity: Int?
-    /// 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.
     public var responseFields: [String]?
     /// Maximum number of facet values to return for each facet.
     public var maxValuesPerFacet: Int?

Sources/Recommend/Models/RecommendIndexSettings.swift

@@ -229,11 +229,13 @@ public struct RecommendIndexSettings: Codable, JSONEncodable {
     /// 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.
     public var minProximity: Int?
-    /// 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.
     public var responseFields: [String]?
     /// Maximum number of facet values to return for each facet.
     public var maxValuesPerFacet: Int?

Sources/Recommend/Models/RecommendSearchParams.swift

@@ -316,11 +316,13 @@ public struct RecommendSearchParams: Codable, JSONEncodable {
     /// 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.
     public var minProximity: Int?
-    /// 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.
     public var responseFields: [String]?
     /// Maximum number of facet values to return for each facet.
     public var maxValuesPerFacet: Int?

Sources/Search/Models/BrowseParamsObject.swift

@@ -217,11 +217,13 @@ public struct BrowseParamsObject: Codable, JSONEncodable {
     /// 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.
     public var minProximity: Int?
-    /// 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.
     public var responseFields: [String]?
     /// Maximum number of facet values to return for each facet.
     public var maxValuesPerFacet: Int?

Sources/Search/Models/IndexSettings.swift

@@ -233,11 +233,13 @@ public struct IndexSettings: Codable, JSONEncodable {
     /// 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.
     public var minProximity: Int?
-    /// 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.
     public var responseFields: [String]?
     /// Maximum number of facet values to return for each facet.
     public var maxValuesPerFacet: Int?

Sources/Search/Models/SearchConsequenceParams.swift

@@ -215,11 +215,13 @@ public struct SearchConsequenceParams: Codable, JSONEncodable {
     /// 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.
     public var minProximity: Int?
-    /// 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.
     public var responseFields: [String]?
     /// Maximum number of facet values to return for each facet.
     public var maxValuesPerFacet: Int?

Sources/Search/Models/SearchForFacets.swift

@@ -219,11 +219,13 @@ public struct SearchForFacets: Codable, JSONEncodable {
     /// 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.
     public var minProximity: Int?
-    /// 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.
     public var responseFields: [String]?
     /// Maximum number of facet values to return for each facet.
     public var maxValuesPerFacet: Int?

Sources/Search/Models/SearchForHits.swift

@@ -219,11 +219,13 @@ public struct SearchForHits: Codable, JSONEncodable {
     /// 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.
     public var minProximity: Int?
-    /// 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.
     public var responseFields: [String]?
     /// Maximum number of facet values to return for each facet.
     public var maxValuesPerFacet: Int?

Sources/Search/Models/SearchIndexSettingsAsSearchParams.swift

@@ -124,11 +124,13 @@ public struct SearchIndexSettingsAsSearchParams: Codable, JSONEncodable {
     /// 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.
     public var minProximity: Int?
-    /// 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.
     public var responseFields: [String]?
     /// Maximum number of facet values to return for each facet.
     public var maxValuesPerFacet: Int?

Sources/Search/Models/SearchSearchParamsObject.swift

@@ -218,11 +218,13 @@ public struct SearchSearchParamsObject: Codable, JSONEncodable {
     /// 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.
     public var minProximity: Int?
-    /// 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.
     public var responseFields: [String]?
     /// Maximum number of facet values to return for each facet.
     public var maxValuesPerFacet: Int?