Skip to content

Commit d7cbf88

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 6ed46c1 commit d7cbf88

File tree

4 files changed

+9
-4
lines changed

4 files changed

+9
-4
lines changed

packages/composition/model/facetOrdering.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
22

3-
import type { Facets } from './facets';
3+
import type { IndexSettingsFacets } from './indexSettingsFacets';
44
import type { Value } from './value';
55

66
/**
77
* Order of facet names and facet values in your UI.
88
*/
99
export type FacetOrdering = {
10-
facets?: Facets | undefined;
10+
facets?: IndexSettingsFacets | undefined;
1111

1212
/**
1313
* Order of facet values. One object for each facet.

packages/composition/model/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ export * from './externalSource';
4747
export * from './facetFilters';
4848
export * from './facetHits';
4949
export * from './facetOrdering';
50-
export * from './facets';
5150
export * from './facetStats';
5251
export * from './getTaskResponse';
5352
export * from './highlightResult';
@@ -56,6 +55,7 @@ export * from './hit';
5655
export * from './hitMetadata';
5756
export * from './hitRankingInfo';
5857
export * from './ignorePlurals';
58+
export * from './indexSettingsFacets';
5959
export * from './injectedItem';
6060
export * from './injectedItemHitsMetadata';
6161
export * from './injectedItemMetadata';

packages/composition/model/facets.ts renamed to packages/composition/model/indexSettingsFacets.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/**
44
* Order of facet names.
55
*/
6-
export type Facets = {
6+
export type IndexSettingsFacets = {
77
/**
88
* Explicit order of facets or facet values. This setting lets you always show specific facets or facet values at the top of the list.
99
*/

packages/composition/model/params.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ export type Params = {
3535
*/
3636
relevancyStrictness?: number | undefined;
3737

38+
/**
39+
* 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).
40+
*/
41+
facets?: Array<string> | undefined;
42+
3843
facetFilters?: FacetFilters | undefined;
3944

4045
optionalFilters?: OptionalFilters | undefined;

0 commit comments

Comments
 (0)