From 23e01eac1c5224e72959207eba99328e7e2dc558 Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Fri, 24 Jan 2025 18:35:21 +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 --- packages/algoliasearch/lite/model/baseRecommendIndexSettings.ts | 2 +- .../algoliasearch/lite/model/indexSettingsAsSearchParams.ts | 2 +- packages/client-search/model/indexSettingsAsSearchParams.ts | 2 +- packages/recommend/model/baseRecommendIndexSettings.ts | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/algoliasearch/lite/model/baseRecommendIndexSettings.ts b/packages/algoliasearch/lite/model/baseRecommendIndexSettings.ts index 07a53745b..c66832538 100644 --- a/packages/algoliasearch/lite/model/baseRecommendIndexSettings.ts +++ b/packages/algoliasearch/lite/model/baseRecommendIndexSettings.ts @@ -147,7 +147,7 @@ export type BaseRecommendIndexSettings = { minProximity?: number; /** - * 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. */ responseFields?: Array; diff --git a/packages/algoliasearch/lite/model/indexSettingsAsSearchParams.ts b/packages/algoliasearch/lite/model/indexSettingsAsSearchParams.ts index d506189f2..6d54e76c2 100644 --- a/packages/algoliasearch/lite/model/indexSettingsAsSearchParams.ts +++ b/packages/algoliasearch/lite/model/indexSettingsAsSearchParams.ts @@ -158,7 +158,7 @@ export type IndexSettingsAsSearchParams = { minProximity?: number; /** - * 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. */ responseFields?: Array; diff --git a/packages/client-search/model/indexSettingsAsSearchParams.ts b/packages/client-search/model/indexSettingsAsSearchParams.ts index d506189f2..6d54e76c2 100644 --- a/packages/client-search/model/indexSettingsAsSearchParams.ts +++ b/packages/client-search/model/indexSettingsAsSearchParams.ts @@ -158,7 +158,7 @@ export type IndexSettingsAsSearchParams = { minProximity?: number; /** - * 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. */ responseFields?: Array; diff --git a/packages/recommend/model/baseRecommendIndexSettings.ts b/packages/recommend/model/baseRecommendIndexSettings.ts index 07a53745b..c66832538 100644 --- a/packages/recommend/model/baseRecommendIndexSettings.ts +++ b/packages/recommend/model/baseRecommendIndexSettings.ts @@ -147,7 +147,7 @@ export type BaseRecommendIndexSettings = { minProximity?: number; /** - * 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. */ responseFields?: Array;