Skip to content

Commit d6cccee

Browse files
feat(specs): add specific documentation for facets query parameter in Composition API (generated)
algolia/api-clients-automation#5477 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clara Muller <[email protected]>
1 parent 3f33278 commit d6cccee

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

src/main/scala/algoliasearch/composition/MainInjectionQueryParameters.scala

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -210,8 +210,11 @@ import algoliasearch.composition.SupportedLanguage._
210210
* the same facet values for the `attributeForDistinct`.
211211
* @param facets
212212
* Facets for which to retrieve facet values that match the search criteria and the number of matching facet values
213-
* To retrieve all facets, use the wildcard character `*`. For more information, see
214-
* [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
213+
* To retrieve all facets, use the wildcard character `*`. To retrieve disjunctive facets lists, annotate any facets
214+
* with the `disjunctive` modifier. For more information, see
215+
* [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts)
216+
* and [disjunctive faceting for Smart
217+
* Groups](https://www.algolia.com/doc/guides/managing-results/compositions/search-based-groups#facets-including-disjunctive-faceting).
215218
* @param hitsPerPage
216219
* Number of hits per page.
217220
* @param maxValuesPerFacet

src/main/scala/algoliasearch/composition/Params.scala

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,11 @@ import algoliasearch.composition.SupportedLanguage._
6161
* Use this setting to strike a balance between the relevance and number of returned results.
6262
* @param facets
6363
* Facets for which to retrieve facet values that match the search criteria and the number of matching facet values
64-
* To retrieve all facets, use the wildcard character `*`. For more information, see
65-
* [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
64+
* To retrieve all facets, use the wildcard character `*`. To retrieve disjunctive facets lists, annotate any facets
65+
* with the `disjunctive` modifier. For more information, see
66+
* [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts)
67+
* and [disjunctive faceting for Smart
68+
* Groups](https://www.algolia.com/doc/guides/managing-results/compositions/search-based-groups#facets-including-disjunctive-faceting).
6669
* @param hitsPerPage
6770
* Number of hits per page.
6871
* @param aroundLatLng
@@ -129,8 +132,8 @@ case class Params(
129132
page: Option[Int] = scala.None,
130133
getRankingInfo: Option[Boolean] = scala.None,
131134
relevancyStrictness: Option[Int] = scala.None,
132-
facets: Option[Seq[String]] = scala.None,
133135
facetFilters: Option[FacetFilters] = scala.None,
136+
facets: Option[Seq[String]] = scala.None,
134137
optionalFilters: Option[OptionalFilters] = scala.None,
135138
numericFilters: Option[NumericFilters] = scala.None,
136139
hitsPerPage: Option[Int] = scala.None,

0 commit comments

Comments
 (0)