Skip to content

Commit c2c73e5

Browse files
committed
feat(specs): add specific documentation for facets query parameter in Composition API
1 parent eafef18 commit c2c73e5

File tree

4 files changed

+24
-4
lines changed

4 files changed

+24
-4
lines changed

specs/composition/common/params/Composition.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,24 @@
1+
# #########################
2+
# ### Category Faceting ###
3+
# #########################
4+
5+
facets:
6+
type: array
7+
items:
8+
type: string
9+
description: |
10+
Facets for which to retrieve facet values that match the search criteria and the number of matching facet values
11+
To retrieve all facets, use the wildcard character `*`.
12+
To retrieve disjunctive facets lists, annotate any facets with the `disjunctive` modifier.
13+
For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts) and [disjunctive faceting for Smart Groups](https://www.algolia.com/doc/guides/managing-results/compositions/search-based-groups#facets-including-disjunctive-faceting).
14+
15+
default: []
16+
example:
17+
- ['category', 'disjunctive(brand)', 'price']
18+
- ['*']
19+
x-categories:
20+
- Faceting
21+
122
# ######################
223
# ### Category Rules ###
324
# ######################

specs/composition/common/params/Search.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,6 @@ enableRules:
7070
exactOnSingleWordQuery:
7171
$ref: '../../../common/schemas/IndexSettings.yml#/exactOnSingleWordQuery'
7272

73-
facets:
74-
$ref: '../../../common/schemas/SearchParams.yml#/baseSearchParamsWithoutQuery/properties/facets'
75-
7673
facetFilters:
7774
$ref: '../../../common/schemas/SearchParams.yml#/facetFilters'
7875

specs/composition/common/schemas/components/Injection.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ mainInjectionQueryParameters:
110110
facetingAfterDistinct:
111111
$ref: '../../params/Search.yml#/facetingAfterDistinct'
112112
facets:
113-
$ref: '../../params/Search.yml#/facets'
113+
$ref: '../../params/Composition.yml#/facets'
114114
hitsPerPage:
115115
$ref: '../../params/Search.yml#/hitsPerPage'
116116
maxValuesPerFacet:

specs/composition/common/schemas/requestBodies/RunParams.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ params:
1515
$ref: '../../params/Search.yml#/relevancyStrictness'
1616
facetFilters:
1717
$ref: '../../params/Search.yml#/facetFilters'
18+
facets:
19+
$ref: '../../params/Composition.yml#/facets'
1820
optionalFilters:
1921
$ref: '../../params/Search.yml#/optionalFilters'
2022
numericFilters:

0 commit comments

Comments
 (0)