File tree Expand file tree Collapse file tree 4 files changed +17
-20
lines changed
composition-full/common/params Expand file tree Collapse file tree 4 files changed +17
-20
lines changed Original file line number Diff line number Diff line change @@ -877,7 +877,7 @@ typoTolerance:
877877 - type : boolean
878878 default : true
879879 description : Whether typo tolerance is active. If true, matches with typos are included in the search results and rank after exact matches.
880- - $ref : ' ./SearchEnums.yml#/typoTolerance '
880+ - $ref : ' ./SearchEnums.yml#/typoToleranceEnum '
881881 x-categories :
882882 - Typos
883883
@@ -956,7 +956,7 @@ facetOrdering:
956956 additionalProperties : false
957957 properties :
958958 facets :
959- $ref : ' #/facetsWithOrder '
959+ $ref : ' #/facets '
960960 values :
961961 $ref : ' #/values'
962962
@@ -1012,7 +1012,7 @@ bannerImageUrl:
10121012 url :
10131013 type : string
10141014
1015- facetsWithOrder :
1015+ facets :
10161016 description : Order of facet names.
10171017 type : object
10181018 additionalProperties : false
Original file line number Diff line number Diff line change @@ -10,7 +10,7 @@ alternativesAsExact:
1010 x-categories :
1111 - Query strategy
1212
13- typoTolerance :
13+ typoToleranceEnum :
1414 type : string
1515 title : typo tolerance
1616 description : |
@@ -19,4 +19,4 @@ typoTolerance:
1919 But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos).
2020 - `strict`. Return matches with the two lowest numbers of typos.
2121 With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.
22- enum : [min, strict, 'true', 'false']
22+ enum : [min, strict, 'true', 'false']
Original file line number Diff line number Diff line change @@ -43,7 +43,17 @@ baseSearchParamsWithoutQuery:
4343 restrictSearchableAttributes :
4444 $ref : ' #/restrictSearchableAttributes'
4545 facets :
46- $ref : ' #/facets'
46+ type : array
47+ items :
48+ type : string
49+ description : |
50+ Facets for which to retrieve facet values that match the search criteria and the number of matching facet values
51+ To retrieve all facets, use the wildcard character `*`.
52+ For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
53+ default : []
54+ example : ['*']
55+ x-categories :
56+ - Faceting
4757 facetingAfterDistinct :
4858 $ref : ' #/facetingAfterDistinct'
4959 page :
@@ -219,19 +229,6 @@ enableABTest:
219229 x-categories :
220230 - Advanced
221231
222- facets :
223- type : array
224- items :
225- type : string
226- description : |
227- Facets for which to retrieve facet values that match the search criteria and the number of matching facet values
228- To retrieve all facets, use the wildcard character `*`.
229- For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
230- default : []
231- example : ['*']
232- x-categories :
233- - Faceting
234-
235232facetFilters :
236233 description : |
237234 Filter the search by facet values, so that only records with the same facet values are retrieved.
Original file line number Diff line number Diff line change @@ -71,7 +71,7 @@ exactOnSingleWordQuery:
7171 $ref : ' ../../../common/schemas/IndexSettings.yml#/exactOnSingleWordQuery'
7272
7373facets :
74- $ref : ' ../../../common/schemas/SearchParams.yml#/facets'
74+ $ref : ' ../../../common/schemas/SearchParams.yml#/baseSearchParamsWithoutQuery/properties/ facets'
7575
7676facetFilters :
7777 $ref : ' ../../../common/schemas/SearchParams.yml#/facetFilters'
You can’t perform that action at this time.
0 commit comments