Skip to content

Commit dcb1b59

Browse files
kai687shortcuts
andauthored
fix(specs): clarify browse parameters (#3333)
Co-authored-by: Clément Vannicatte <[email protected]>
1 parent aad2712 commit dcb1b59

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

specs/search/paths/search/browse.yml

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,23 @@ post:
1414
1515
- The Analytics API doesn't collect data when using `browse`.
1616
- Records are ranked by attributes and custom ranking.
17-
- Deduplication (`distinct`) is turned off.
1817
- There's no ranking for: typo-tolerance, number of matched words, proximity, geo distance.
18+
19+
Browse requests automatically apply these settings:
20+
21+
- `advancedSyntax`: `false`
22+
- `attributesToHighlight`: `[]`
23+
- `attributesToSnippet`: `[]`
24+
- `distinct`: `false`
25+
- `enablePersonalization`: `false`
26+
- `enableRules`: `false`
27+
- `facets`: `[]`
28+
- `getRankingInfo`: `false`
29+
- `ignorePlurals`: `false`
30+
- `optionalFilters`: `[]`
31+
- `typoTolerance`: `true` or `false` (`min` and `strict` is evaluated to `true`)
32+
33+
If you send these parameters with your browse requests, they'll be ignored.
1934
parameters:
2035
- $ref: '../../../common/parameters.yml#/IndexName'
2136
requestBody:

0 commit comments

Comments
 (0)