Skip to content

Commit 506b8a5

Browse files
authored
fix(specs): responseFields description (#4399)
1 parent 2f7d20e commit 506b8a5

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

specs/common/schemas/IndexSettings.yml

+9-5
Original file line numberDiff line numberDiff line change
@@ -671,16 +671,20 @@ indexSettingsAsSearchParams:
671671
items:
672672
type: string
673673
description: |
674-
Properties to include in the API response of `search` and `browse` requests.
674+
Properties to include in the API response of search and browse requests.
675675
676676
By default, all response properties are included.
677-
To reduce the response size, you can select, which attributes should be included.
677+
To reduce the response size, you can select which properties should be included.
678+
679+
An empty list may lead to an empty API response (except properties you can't exclude).
678680
679681
You can't exclude these properties:
680-
`message`, `warning`, `cursor`, `serverUsed`, `indexUsed`,
681-
`abTestVariantID`, `parsedQuery`, or any property triggered by the `getRankingInfo` parameter.
682+
`message`, `warning`, `cursor`, `abTestVariantID`,
683+
or any property added by setting `getRankingInfo` to true.
682684
683-
Don't exclude properties that you might need in your search UI.
685+
Your search depends on the `hits` field. If you omit this field, searches won't return any results.
686+
Your UI might also depend on other properties, for example, for pagination.
687+
Before restricting the response size, check the impact on your search experience.
684688
default: ['*']
685689
x-categories:
686690
- Advanced

0 commit comments

Comments
 (0)