Skip to content

Commit 5a93283

Browse files
algolia-botClaraMullermillotp
committed
feat(specs): add facets query parameter available at run time (generated)
algolia/api-clients-automation#5486 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clara Muller <[email protected]> Co-authored-by: Pierre Millot <[email protected]>
1 parent 068ff50 commit 5a93283

File tree

3 files changed

+14
-2
lines changed

3 files changed

+14
-2
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import kotlinx.serialization.json.*
1515
*/
1616
@Serializable
1717
public data class FacetOrdering(
18-
@SerialName(value = "facets") val facets: Facets? = null,
18+
@SerialName(value = "facets") val facets: IndexSettingsFacets? = null,
1919

2020
/** Order of facet values. One object for each facet. */
2121
@SerialName(value = "values") val values: Map<kotlin.String, Value>? = null,

client/src/commonMain/kotlin/com/algolia/client/model/composition/Facets.kt renamed to client/src/commonMain/kotlin/com/algolia/client/model/composition/IndexSettingsFacets.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import kotlinx.serialization.json.*
1414
* facets or facet values at the top of the list.
1515
*/
1616
@Serializable
17-
public data class Facets(
17+
public data class IndexSettingsFacets(
1818

1919
/**
2020
* Explicit order of facets or facet values. This setting lets you always show specific facets or

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ 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 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+
* more information, see
39+
* [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
3640
* @param facetFilters
3741
* @param optionalFilters
3842
* @param numericFilters
@@ -128,6 +132,14 @@ public data class Params(
128132
* Use this setting to strike a balance between the relevance and number of returned results.
129133
*/
130134
@SerialName(value = "relevancyStrictness") val relevancyStrictness: Int? = null,
135+
136+
/**
137+
* 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
139+
* information, see
140+
* [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
141+
*/
142+
@SerialName(value = "facets") val facets: List<String>? = null,
131143
@SerialName(value = "facetFilters") val facetFilters: FacetFilters? = null,
132144
@SerialName(value = "optionalFilters") val optionalFilters: OptionalFilters? = null,
133145
@SerialName(value = "numericFilters") val numericFilters: NumericFilters? = null,

0 commit comments

Comments
 (0)