Skip to content

Commit

Permalink
fix(specs): clarify browse parameters (#3333)
Browse files Browse the repository at this point in the history
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
  • Loading branch information
kai687 and shortcuts authored Jul 8, 2024
1 parent aad2712 commit dcb1b59
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion specs/search/paths/search/browse.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,23 @@ post:
- The Analytics API doesn't collect data when using `browse`.
- Records are ranked by attributes and custom ranking.
- Deduplication (`distinct`) is turned off.
- There's no ranking for: typo-tolerance, number of matched words, proximity, geo distance.
Browse requests automatically apply these settings:
- `advancedSyntax`: `false`
- `attributesToHighlight`: `[]`
- `attributesToSnippet`: `[]`
- `distinct`: `false`
- `enablePersonalization`: `false`
- `enableRules`: `false`
- `facets`: `[]`
- `getRankingInfo`: `false`
- `ignorePlurals`: `false`
- `optionalFilters`: `[]`
- `typoTolerance`: `true` or `false` (`min` and `strict` is evaluated to `true`)
If you send these parameters with your browse requests, they'll be ignored.
parameters:
- $ref: '../../../common/parameters.yml#/IndexName'
requestBody:
Expand Down

0 comments on commit dcb1b59

Please # to comment.