Skip to content

fix(specs): responseFields description #4399

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 24, 2025
Merged

fix(specs): responseFields description #4399

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions specs/common/schemas/IndexSettings.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down