From 78e059f4507c59fb44b1adc9d3de9a9952395687 Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Fri, 24 Jan 2025 18:35:24 +0000 Subject: [PATCH] fix(specs): responseFields description (generated) https://github.com/algolia/api-clients-automation/pull/4399 Co-authored-by: algolia-bot Co-authored-by: Kai Welke --- lib/Model/Recommend/FallbackParams.php | 2 +- lib/Model/Recommend/RecommendSearchParams.php | 2 +- lib/Model/Search/BrowseParams.php | 2 +- lib/Model/Search/BrowseParamsObject.php | 2 +- lib/Model/Search/ConsequenceParams.php | 2 +- lib/Model/Search/IndexSettings.php | 2 +- lib/Model/Search/SearchForFacets.php | 2 +- lib/Model/Search/SearchForHits.php | 2 +- lib/Model/Search/SearchParams.php | 2 +- lib/Model/Search/SearchParamsObject.php | 2 +- lib/Model/Search/SearchQuery.php | 2 +- lib/Model/Search/SettingsResponse.php | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/lib/Model/Recommend/FallbackParams.php b/lib/Model/Recommend/FallbackParams.php index c52e64d8..c13aece8 100644 --- a/lib/Model/Recommend/FallbackParams.php +++ b/lib/Model/Recommend/FallbackParams.php @@ -2772,7 +2772,7 @@ public function getResponseFields() /** * Sets responseFields. * - * @param null|string[] $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. + * @param null|string[] $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 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. * * @return self */ diff --git a/lib/Model/Recommend/RecommendSearchParams.php b/lib/Model/Recommend/RecommendSearchParams.php index a3d1fcef..d49fde90 100644 --- a/lib/Model/Recommend/RecommendSearchParams.php +++ b/lib/Model/Recommend/RecommendSearchParams.php @@ -2774,7 +2774,7 @@ public function getResponseFields() /** * Sets responseFields. * - * @param null|string[] $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. + * @param null|string[] $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 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. * * @return self */ diff --git a/lib/Model/Search/BrowseParams.php b/lib/Model/Search/BrowseParams.php index a5522e2c..fdff38f0 100644 --- a/lib/Model/Search/BrowseParams.php +++ b/lib/Model/Search/BrowseParams.php @@ -2364,7 +2364,7 @@ public function getResponseFields() /** * Sets responseFields. * - * @param null|string[] $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. + * @param null|string[] $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 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. * * @return self */ diff --git a/lib/Model/Search/BrowseParamsObject.php b/lib/Model/Search/BrowseParamsObject.php index 442970f8..d71383a9 100644 --- a/lib/Model/Search/BrowseParamsObject.php +++ b/lib/Model/Search/BrowseParamsObject.php @@ -2332,7 +2332,7 @@ public function getResponseFields() /** * Sets responseFields. * - * @param null|string[] $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. + * @param null|string[] $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 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. * * @return self */ diff --git a/lib/Model/Search/ConsequenceParams.php b/lib/Model/Search/ConsequenceParams.php index 67c95365..b728375c 100644 --- a/lib/Model/Search/ConsequenceParams.php +++ b/lib/Model/Search/ConsequenceParams.php @@ -2316,7 +2316,7 @@ public function getResponseFields() /** * Sets responseFields. * - * @param null|string[] $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. + * @param null|string[] $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 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. * * @return self */ diff --git a/lib/Model/Search/IndexSettings.php b/lib/Model/Search/IndexSettings.php index 9206d8f6..4d2a05ff 100644 --- a/lib/Model/Search/IndexSettings.php +++ b/lib/Model/Search/IndexSettings.php @@ -1942,7 +1942,7 @@ public function getResponseFields() /** * Sets responseFields. * - * @param null|string[] $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. + * @param null|string[] $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 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. * * @return self */ diff --git a/lib/Model/Search/SearchForFacets.php b/lib/Model/Search/SearchForFacets.php index 87d41dc8..18cbaceb 100644 --- a/lib/Model/Search/SearchForFacets.php +++ b/lib/Model/Search/SearchForFacets.php @@ -2408,7 +2408,7 @@ public function getResponseFields() /** * Sets responseFields. * - * @param null|string[] $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. + * @param null|string[] $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 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. * * @return self */ diff --git a/lib/Model/Search/SearchForHits.php b/lib/Model/Search/SearchForHits.php index 3e60bfda..2d66a6ab 100644 --- a/lib/Model/Search/SearchForHits.php +++ b/lib/Model/Search/SearchForHits.php @@ -2378,7 +2378,7 @@ public function getResponseFields() /** * Sets responseFields. * - * @param null|string[] $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. + * @param null|string[] $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 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. * * @return self */ diff --git a/lib/Model/Search/SearchParams.php b/lib/Model/Search/SearchParams.php index e7ccdc18..59770aa9 100644 --- a/lib/Model/Search/SearchParams.php +++ b/lib/Model/Search/SearchParams.php @@ -2356,7 +2356,7 @@ public function getResponseFields() /** * Sets responseFields. * - * @param null|string[] $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. + * @param null|string[] $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 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. * * @return self */ diff --git a/lib/Model/Search/SearchParamsObject.php b/lib/Model/Search/SearchParamsObject.php index 9eaf5763..e2a492db 100644 --- a/lib/Model/Search/SearchParamsObject.php +++ b/lib/Model/Search/SearchParamsObject.php @@ -2326,7 +2326,7 @@ public function getResponseFields() /** * Sets responseFields. * - * @param null|string[] $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. + * @param null|string[] $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 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. * * @return self */ diff --git a/lib/Model/Search/SearchQuery.php b/lib/Model/Search/SearchQuery.php index 41d73c0c..e20b5229 100644 --- a/lib/Model/Search/SearchQuery.php +++ b/lib/Model/Search/SearchQuery.php @@ -2408,7 +2408,7 @@ public function getResponseFields() /** * Sets responseFields. * - * @param null|string[] $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. + * @param null|string[] $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 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. * * @return self */ diff --git a/lib/Model/Search/SettingsResponse.php b/lib/Model/Search/SettingsResponse.php index 81bf5cb0..a46eaf8b 100644 --- a/lib/Model/Search/SettingsResponse.php +++ b/lib/Model/Search/SettingsResponse.php @@ -1948,7 +1948,7 @@ public function getResponseFields() /** * Sets responseFields. * - * @param null|string[] $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. + * @param null|string[] $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 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. * * @return self */