Skip to content

Commit 1152c4d

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 32301c6 commit 1152c4d

File tree

2 files changed

+27
-21
lines changed

2 files changed

+27
-21
lines changed

algoliasearch/src/main/java/com/algolia/model/composition/MainInjectionQueryParameters.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -985,9 +985,12 @@ public MainInjectionQueryParameters addFacets(String facetsItem) {
985985

986986
/**
987987
* Facets for which to retrieve facet values that match the search criteria and the number of
988-
* matching facet values To retrieve all facets, use the wildcard character `*`. For more
988+
* matching facet values To retrieve all facets, use the wildcard character `*`. To retrieve
989+
* disjunctive facets lists, annotate any facets with the `disjunctive` modifier. For more
989990
* information, see
990-
* [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
991+
* [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts)
992+
* and [disjunctive faceting for Smart
993+
* Groups](https://www.algolia.com/doc/guides/managing-results/compositions/search-based-groups#facets-including-disjunctive-faceting).
991994
*/
992995
@javax.annotation.Nullable
993996
public List<String> getFacets() {

algoliasearch/src/main/java/com/algolia/model/composition/Params.java

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ public class Params {
2929
@JsonProperty("relevancyStrictness")
3030
private Integer relevancyStrictness;
3131

32-
@JsonProperty("facets")
33-
private List<String> facets;
34-
3532
@JsonProperty("facetFilters")
3633
private FacetFilters facetFilters;
3734

35+
@JsonProperty("facets")
36+
private List<String> facets;
37+
3838
@JsonProperty("optionalFilters")
3939
private OptionalFilters optionalFilters;
4040

@@ -174,6 +174,17 @@ public Integer getRelevancyStrictness() {
174174
return relevancyStrictness;
175175
}
176176

177+
public Params setFacetFilters(FacetFilters facetFilters) {
178+
this.facetFilters = facetFilters;
179+
return this;
180+
}
181+
182+
/** Get facetFilters */
183+
@javax.annotation.Nullable
184+
public FacetFilters getFacetFilters() {
185+
return facetFilters;
186+
}
187+
177188
public Params setFacets(List<String> facets) {
178189
this.facets = facets;
179190
return this;
@@ -189,26 +200,18 @@ public Params addFacets(String facetsItem) {
189200

190201
/**
191202
* Facets for which to retrieve facet values that match the search criteria and the number of
192-
* matching facet values To retrieve all facets, use the wildcard character `*`. For more
203+
* matching facet values To retrieve all facets, use the wildcard character `*`. To retrieve
204+
* disjunctive facets lists, annotate any facets with the `disjunctive` modifier. For more
193205
* information, see
194-
* [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
206+
* [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts)
207+
* and [disjunctive faceting for Smart
208+
* Groups](https://www.algolia.com/doc/guides/managing-results/compositions/search-based-groups#facets-including-disjunctive-faceting).
195209
*/
196210
@javax.annotation.Nullable
197211
public List<String> getFacets() {
198212
return facets;
199213
}
200214

201-
public Params setFacetFilters(FacetFilters facetFilters) {
202-
this.facetFilters = facetFilters;
203-
return this;
204-
}
205-
206-
/** Get facetFilters */
207-
@javax.annotation.Nullable
208-
public FacetFilters getFacetFilters() {
209-
return facetFilters;
210-
}
211-
212215
public Params setOptionalFilters(OptionalFilters optionalFilters) {
213216
this.optionalFilters = optionalFilters;
214217
return this;
@@ -558,8 +561,8 @@ public boolean equals(Object o) {
558561
Objects.equals(this.page, params.page) &&
559562
Objects.equals(this.getRankingInfo, params.getRankingInfo) &&
560563
Objects.equals(this.relevancyStrictness, params.relevancyStrictness) &&
561-
Objects.equals(this.facets, params.facets) &&
562564
Objects.equals(this.facetFilters, params.facetFilters) &&
565+
Objects.equals(this.facets, params.facets) &&
563566
Objects.equals(this.optionalFilters, params.optionalFilters) &&
564567
Objects.equals(this.numericFilters, params.numericFilters) &&
565568
Objects.equals(this.hitsPerPage, params.hitsPerPage) &&
@@ -592,8 +595,8 @@ public int hashCode() {
592595
page,
593596
getRankingInfo,
594597
relevancyStrictness,
595-
facets,
596598
facetFilters,
599+
facets,
597600
optionalFilters,
598601
numericFilters,
599602
hitsPerPage,
@@ -627,8 +630,8 @@ public String toString() {
627630
sb.append(" page: ").append(toIndentedString(page)).append("\n");
628631
sb.append(" getRankingInfo: ").append(toIndentedString(getRankingInfo)).append("\n");
629632
sb.append(" relevancyStrictness: ").append(toIndentedString(relevancyStrictness)).append("\n");
630-
sb.append(" facets: ").append(toIndentedString(facets)).append("\n");
631633
sb.append(" facetFilters: ").append(toIndentedString(facetFilters)).append("\n");
634+
sb.append(" facets: ").append(toIndentedString(facets)).append("\n");
632635
sb.append(" optionalFilters: ").append(toIndentedString(optionalFilters)).append("\n");
633636
sb.append(" numericFilters: ").append(toIndentedString(numericFilters)).append("\n");
634637
sb.append(" hitsPerPage: ").append(toIndentedString(hitsPerPage)).append("\n");

0 commit comments

Comments
 (0)