Skip to content

Commit 74ae1b3

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 6af3c53 commit 74ae1b3

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

packages/client_composition/lib/src/model/main_injection_query_parameters.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ final class MainInjectionQueryParameters {
286286
@JsonKey(name: r'facetingAfterDistinct')
287287
final bool? facetingAfterDistinct;
288288

289-
/// Facets for which to retrieve facet values that match the search criteria and the number of matching facet values To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
289+
/// Facets for which to retrieve facet values that match the search criteria and the number of matching facet values To retrieve all facets, use the wildcard character `*`. To retrieve disjunctive facets lists, annotate any facets with the `disjunctive` modifier. 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).
290290
@JsonKey(name: r'facets')
291291
final List<String>? facets;
292292

packages/client_composition/lib/src/model/params.dart

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ final class Params {
1616
this.page,
1717
this.getRankingInfo,
1818
this.relevancyStrictness,
19-
this.facets,
2019
this.facetFilters,
20+
this.facets,
2121
this.optionalFilters,
2222
this.numericFilters,
2323
this.hitsPerPage,
@@ -62,17 +62,17 @@ final class Params {
6262
@JsonKey(name: r'relevancyStrictness')
6363
final int? relevancyStrictness;
6464

65-
/// Facets for which to retrieve facet values that match the search criteria and the number of matching facet values To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
66-
@JsonKey(name: r'facets')
67-
final List<String>? facets;
68-
6965
/// One of types:
7066
/// - [List<List<FacetFilters>>]
7167
/// - [String]
7268
/// - [List<String>]
7369
@JsonKey(name: r'facetFilters')
7470
final dynamic facetFilters;
7571

72+
/// Facets for which to retrieve facet values that match the search criteria and the number of matching facet values To retrieve all facets, use the wildcard character `*`. To retrieve disjunctive facets lists, annotate any facets with the `disjunctive` modifier. 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).
73+
@JsonKey(name: r'facets')
74+
final List<String>? facets;
75+
7676
/// One of types:
7777
/// - [String]
7878
/// - [List<List<OptionalFilters>>]
@@ -181,8 +181,8 @@ final class Params {
181181
other.page == page &&
182182
other.getRankingInfo == getRankingInfo &&
183183
other.relevancyStrictness == relevancyStrictness &&
184-
other.facets == facets &&
185184
other.facetFilters == facetFilters &&
185+
other.facets == facets &&
186186
other.optionalFilters == optionalFilters &&
187187
other.numericFilters == numericFilters &&
188188
other.hitsPerPage == hitsPerPage &&
@@ -212,8 +212,8 @@ final class Params {
212212
page.hashCode +
213213
getRankingInfo.hashCode +
214214
relevancyStrictness.hashCode +
215-
facets.hashCode +
216215
facetFilters.hashCode +
216+
facets.hashCode +
217217
optionalFilters.hashCode +
218218
numericFilters.hashCode +
219219
hitsPerPage.hashCode +

packages/client_composition/lib/src/model/params.g.dart

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)