Skip to content

Commit 0193697

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 <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>
1 parent 21918ed commit 0193697

File tree

2 files changed

+22
-10
lines changed

2 files changed

+22
-10
lines changed

client/src/commonMain/kotlin/com/algolia/client/model/composition/MainInjectionQueryParameters.kt

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -184,9 +184,12 @@ import kotlinx.serialization.json.*
184184
* setting, as `facetingAfterDistinct` only computes correct facet counts if all records have the
185185
* same facet values for the `attributeForDistinct`.
186186
* @param facets Facets for which to retrieve facet values that match the search criteria and the
187-
* number of matching facet values To retrieve all facets, use the wildcard character `*`. For
187+
* number of matching facet values To retrieve all facets, use the wildcard character `*`. To
188+
* retrieve disjunctive facets lists, annotate any facets with the `disjunctive` modifier. For
188189
* more information, see
189-
* [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
190+
* [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts)
191+
* and
192+
* [disjunctive faceting for Smart Groups](https://www.algolia.com/doc/guides/managing-results/compositions/search-based-groups#facets-including-disjunctive-faceting).
190193
* @param hitsPerPage Number of hits per page.
191194
* @param maxValuesPerFacet Maximum number of facet values to return for each facet.
192195
* @param renderingContent
@@ -502,9 +505,12 @@ public data class MainInjectionQueryParameters(
502505

503506
/**
504507
* Facets for which to retrieve facet values that match the search criteria and the number of
505-
* matching facet values To retrieve all facets, use the wildcard character `*`. For more
508+
* matching facet values To retrieve all facets, use the wildcard character `*`. To retrieve
509+
* disjunctive facets lists, annotate any facets with the `disjunctive` modifier. For more
506510
* information, see
507-
* [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
511+
* [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts)
512+
* and
513+
* [disjunctive faceting for Smart Groups](https://www.algolia.com/doc/guides/managing-results/compositions/search-based-groups#facets-including-disjunctive-faceting).
508514
*/
509515
@SerialName(value = "facets") val facets: List<String>? = null,
510516

client/src/commonMain/kotlin/com/algolia/client/model/composition/Params.kt

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,14 @@ import kotlinx.serialization.json.*
3333
* in the results You can only set `relevancyStrictness` on
3434
* [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas).
3535
* Use this setting to strike a balance between the relevance and number of returned results.
36+
* @param facetFilters
3637
* @param facets Facets for which to retrieve facet values that match the search criteria and the
37-
* number of matching facet values To retrieve all facets, use the wildcard character `*`. For
38+
* number of matching facet values To retrieve all facets, use the wildcard character `*`. To
39+
* retrieve disjunctive facets lists, annotate any facets with the `disjunctive` modifier. For
3840
* more information, see
39-
* [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
40-
* @param facetFilters
41+
* [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts)
42+
* and
43+
* [disjunctive faceting for Smart Groups](https://www.algolia.com/doc/guides/managing-results/compositions/search-based-groups#facets-including-disjunctive-faceting).
4144
* @param optionalFilters
4245
* @param numericFilters
4346
* @param hitsPerPage Number of hits per page.
@@ -132,15 +135,18 @@ public data class Params(
132135
* Use this setting to strike a balance between the relevance and number of returned results.
133136
*/
134137
@SerialName(value = "relevancyStrictness") val relevancyStrictness: Int? = null,
138+
@SerialName(value = "facetFilters") val facetFilters: FacetFilters? = null,
135139

136140
/**
137141
* Facets for which to retrieve facet values that match the search criteria and the number of
138-
* matching facet values To retrieve all facets, use the wildcard character `*`. For more
142+
* matching facet values To retrieve all facets, use the wildcard character `*`. To retrieve
143+
* disjunctive facets lists, annotate any facets with the `disjunctive` modifier. For more
139144
* information, see
140-
* [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
145+
* [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts)
146+
* and
147+
* [disjunctive faceting for Smart Groups](https://www.algolia.com/doc/guides/managing-results/compositions/search-based-groups#facets-including-disjunctive-faceting).
141148
*/
142149
@SerialName(value = "facets") val facets: List<String>? = null,
143-
@SerialName(value = "facetFilters") val facetFilters: FacetFilters? = null,
144150
@SerialName(value = "optionalFilters") val optionalFilters: OptionalFilters? = null,
145151
@SerialName(value = "numericFilters") val numericFilters: NumericFilters? = null,
146152

0 commit comments

Comments
 (0)