From 506b8a5636cb68fb45d83d9d33aa303a13ed82e2 Mon Sep 17 00:00:00 2001 From: Kai Welke Date: Fri, 24 Jan 2025 19:18:38 +0100 Subject: [PATCH] fix(specs): responseFields description (#4399) --- specs/common/schemas/IndexSettings.yml | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/specs/common/schemas/IndexSettings.yml b/specs/common/schemas/IndexSettings.yml index 1929466761..4ed633bb05 100644 --- a/specs/common/schemas/IndexSettings.yml +++ b/specs/common/schemas/IndexSettings.yml @@ -671,16 +671,20 @@ indexSettingsAsSearchParams: items: type: string description: | - Properties to include in the API response of `search` and `browse` requests. + 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. + 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`, `serverUsed`, `indexUsed`, - `abTestVariantID`, `parsedQuery`, or any property triggered by the `getRankingInfo` parameter. + `message`, `warning`, `cursor`, `abTestVariantID`, + or any property added by setting `getRankingInfo` to true. - Don't exclude properties that you might need in your search UI. + 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. default: ['*'] x-categories: - Advanced