Skip to content

Commit 1133a8d

Browse files
feat(specs): add specific documentation for facets query parameter in Composition API (generated)
Co-authored-by: Clara Muller <[email protected]>
1 parent dbb02c5 commit 1133a8d

File tree

25 files changed

+276
-221
lines changed

25 files changed

+276
-221
lines changed

clients/algoliasearch-client-csharp/algoliasearch/Models/Composition/MainInjectionQueryParameters.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -347,9 +347,9 @@ public MainInjectionQueryParameters() { }
347347
public bool? FacetingAfterDistinct { get; set; }
348348

349349
/// <summary>
350-
/// 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).
350+
/// 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).
351351
/// </summary>
352-
/// <value>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). </value>
352+
/// <value>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). </value>
353353
[JsonPropertyName("facets")]
354354
public List<string> Facets { get; set; }
355355

clients/algoliasearch-client-csharp/algoliasearch/Models/Composition/Params.cs

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -56,19 +56,19 @@ public Params() { }
5656
[JsonPropertyName("relevancyStrictness")]
5757
public int? RelevancyStrictness { get; set; }
5858

59-
/// <summary>
60-
/// 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).
61-
/// </summary>
62-
/// <value>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). </value>
63-
[JsonPropertyName("facets")]
64-
public List<string> Facets { get; set; }
65-
6659
/// <summary>
6760
/// Gets or Sets FacetFilters
6861
/// </summary>
6962
[JsonPropertyName("facetFilters")]
7063
public FacetFilters FacetFilters { get; set; }
7164

65+
/// <summary>
66+
/// 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).
67+
/// </summary>
68+
/// <value>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). </value>
69+
[JsonPropertyName("facets")]
70+
public List<string> Facets { get; set; }
71+
7272
/// <summary>
7373
/// Gets or Sets OptionalFilters
7474
/// </summary>
@@ -224,8 +224,8 @@ public override string ToString()
224224
sb.Append(" Page: ").Append(Page).Append("\n");
225225
sb.Append(" GetRankingInfo: ").Append(GetRankingInfo).Append("\n");
226226
sb.Append(" RelevancyStrictness: ").Append(RelevancyStrictness).Append("\n");
227-
sb.Append(" Facets: ").Append(Facets).Append("\n");
228227
sb.Append(" FacetFilters: ").Append(FacetFilters).Append("\n");
228+
sb.Append(" Facets: ").Append(Facets).Append("\n");
229229
sb.Append(" OptionalFilters: ").Append(OptionalFilters).Append("\n");
230230
sb.Append(" NumericFilters: ").Append(NumericFilters).Append("\n");
231231
sb.Append(" HitsPerPage: ").Append(HitsPerPage).Append("\n");
@@ -280,14 +280,14 @@ public override bool Equals(object obj)
280280
RelevancyStrictness == input.RelevancyStrictness
281281
|| RelevancyStrictness.Equals(input.RelevancyStrictness)
282282
)
283-
&& (
284-
Facets == input.Facets
285-
|| Facets != null && input.Facets != null && Facets.SequenceEqual(input.Facets)
286-
)
287283
&& (
288284
FacetFilters == input.FacetFilters
289285
|| (FacetFilters != null && FacetFilters.Equals(input.FacetFilters))
290286
)
287+
&& (
288+
Facets == input.Facets
289+
|| Facets != null && input.Facets != null && Facets.SequenceEqual(input.Facets)
290+
)
291291
&& (
292292
OptionalFilters == input.OptionalFilters
293293
|| (OptionalFilters != null && OptionalFilters.Equals(input.OptionalFilters))
@@ -385,14 +385,14 @@ public override int GetHashCode()
385385
hashCode = (hashCode * 59) + Page.GetHashCode();
386386
hashCode = (hashCode * 59) + GetRankingInfo.GetHashCode();
387387
hashCode = (hashCode * 59) + RelevancyStrictness.GetHashCode();
388-
if (Facets != null)
389-
{
390-
hashCode = (hashCode * 59) + Facets.GetHashCode();
391-
}
392388
if (FacetFilters != null)
393389
{
394390
hashCode = (hashCode * 59) + FacetFilters.GetHashCode();
395391
}
392+
if (Facets != null)
393+
{
394+
hashCode = (hashCode * 59) + Facets.GetHashCode();
395+
}
396396
if (OptionalFilters != null)
397397
{
398398
hashCode = (hashCode * 59) + OptionalFilters.GetHashCode();

clients/algoliasearch-client-dart/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

clients/algoliasearch-client-dart/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 +

clients/algoliasearch-client-dart/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.

clients/algoliasearch-client-go/algolia/composition/model_main_injection_query_parameters.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

clients/algoliasearch-client-go/algolia/composition/model_params.go

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

0 commit comments

Comments
 (0)