From dcb1b59dc4e9dedd8dd527bca9670bca8f290af8 Mon Sep 17 00:00:00 2001 From: Kai Welke Date: Mon, 8 Jul 2024 21:53:23 +0200 Subject: [PATCH] fix(specs): clarify browse parameters (#3333) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Clément Vannicatte --- specs/search/paths/search/browse.yml | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/specs/search/paths/search/browse.yml b/specs/search/paths/search/browse.yml index 30991325f6..2b85f23b37 100644 --- a/specs/search/paths/search/browse.yml +++ b/specs/search/paths/search/browse.yml @@ -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: