Skip to content

Commit

Permalink
fix(specs): responseFields description (#4399)
Browse files Browse the repository at this point in the history
  • Loading branch information
kai687 authored Jan 24, 2025
1 parent 2f7d20e commit 506b8a5
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions specs/common/schemas/IndexSettings.yml
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

0 comments on commit 506b8a5

Please sign in to comment.