Skip to content

Commit 5ea8250

Browse files
algolia-bote-krebsshortcuts
committed
feat(specs): update composition specs according to upcoming API changes (generated)
algolia/api-clients-automation#4234 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Emmanuel Krebs <e-krebs@users.noreply.github.com> Co-authored-by: shortcuts <vannicattec@gmail.com>
1 parent 781b14d commit 5ea8250

19 files changed

+110
-27
lines changed

‎packages/client-composition/model/composition.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ export type Composition = {
1111
/**
1212
* Composition name.
1313
*/
14+
name: string;
15+
16+
/**
17+
* Composition description.
18+
*/
1419
description?: string;
1520

1621
behavior: CompositionBehavior;

‎packages/client-composition/model/compositionBaseSearchResponse.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
// 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.
2+
3+
import type { CompositionsSearchResponse } from './compositionsSearchResponse';
4+
5+
export type CompositionBaseSearchResponse = Record<string, any> & {
6+
compositions?: CompositionsSearchResponse;
7+
};

packages/client-composition/model/composedRankingInfo.ts renamed to packages/client-composition/model/compositionIdRankingInfo.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
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-
export type ComposedRankingInfo = {
3+
export type CompositionIdRankingInfo = {
44
index: string;
55

6-
inset: string;
6+
injectedItemKey: string;
77
};

‎packages/client-composition/model/compositionRankingInfo.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
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 { ComposedRankingInfo } from './composedRankingInfo';
3+
import type { CompositionIdRankingInfo } from './compositionIdRankingInfo';
44

55
export type CompositionRankingInfo = {
6-
composed?: ComposedRankingInfo;
6+
composed?: { [key: string]: CompositionIdRankingInfo };
77
};

‎packages/client-composition/model/compositionRunAppliedRules.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// 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.
2+
3+
export type CompositionRunAppliedRules = {
4+
/**
5+
* Unique record identifier.
6+
*/
7+
objectID: string;
8+
};

‎packages/client-composition/model/compositionRunSearchResponse.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
// 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.
2+
3+
import type { CompositionRunAppliedRules } from './compositionRunAppliedRules';
4+
5+
export type CompositionRunSearchResponse = Record<string, any> & {
6+
/**
7+
* Unique record identifier.
8+
*/
9+
objectID: string;
10+
11+
appliedRules?: Array<CompositionRunAppliedRules>;
12+
};

‎packages/client-composition/model/compositionsSearchResponse.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
// 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.
2+
3+
import type { CompositionRunSearchResponse } from './compositionRunSearchResponse';
4+
5+
export type CompositionsSearchResponse = Record<string, any> & {
6+
run: Array<CompositionRunSearchResponse>;
7+
};

‎packages/client-composition/model/index.ts‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,19 @@ export * from './batchCompositionAction';
1616
export * from './batchParams';
1717
export * from './booleanString';
1818
export * from './clientMethodProps';
19-
export * from './composedRankingInfo';
2019
export * from './composition';
20+
export * from './compositionBaseSearchResponse';
2121
export * from './compositionBehavior';
22-
export * from './compositionInset';
23-
export * from './compositionInsetSource';
24-
export * from './compositionInsetSourceSearch';
22+
export * from './compositionIdRankingInfo';
2523
export * from './compositionRankingInfo';
2624
export * from './compositionRule';
2725
export * from './compositionRuleConsequence';
2826
export * from './compositionRulesBatchParams';
27+
export * from './compositionRunAppliedRules';
28+
export * from './compositionRunSearchResponse';
2929
export * from './compositionSource';
3030
export * from './compositionSourceSearch';
31+
export * from './compositionsSearchResponse';
3132
export * from './condition';
3233
export * from './deleteCompositionAction';
3334
export * from './deleteCompositionRuleAction';
@@ -46,8 +47,11 @@ export * from './highlightResultOption';
4647
export * from './hit';
4748
export * from './hitRankingInfo';
4849
export * from './ignorePlurals';
50+
export * from './injectedItem';
51+
export * from './injectedItemSource';
52+
export * from './injectedItemSourceSearch';
53+
export * from './injectedItemsQueryParameters';
4954
export * from './injection';
50-
export * from './insetsQueryParameters';
5155
export * from './insideBoundingBox';
5256
export * from './listCompositionsResponse';
5357
export * from './main';
@@ -72,6 +76,10 @@ export * from './removeStopWords';
7276
export * from './removeWordsIfNoResults';
7377
export * from './renderingContent';
7478
export * from './requestBody';
79+
export * from './resultsCompositionInfoResponse';
80+
export * from './resultsCompositionsResponse';
81+
export * from './resultsInjectedItemAppliedRulesInfoResponse';
82+
export * from './resultsInjectedItemInfoResponse';
7583
export * from './rulesBatchCompositionAction';
7684
export * from './rulesMultipleBatchRequest';
7785
export * from './rulesMultipleBatchResponse';

packages/client-composition/model/compositionInset.ts renamed to packages/client-composition/model/injectedItem.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
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 { CompositionInsetSource } from './compositionInsetSource';
3+
import type { InjectedItemSource } from './injectedItemSource';
44

5-
export type CompositionInset = {
5+
export type InjectedItem = {
66
/**
7-
* Inset name.
7+
* injected Item unique identifier.
88
*/
9-
name: string;
9+
key: string;
1010

11-
source: CompositionInsetSource;
11+
source: InjectedItemSource;
1212

1313
position: number;
1414

packages/client-composition/model/compositionInsetSource.ts renamed to packages/client-composition/model/injectedItemSource.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
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 { CompositionInsetSourceSearch } from './compositionInsetSourceSearch';
3+
import type { InjectedItemSourceSearch } from './injectedItemSourceSearch';
44

5-
export type CompositionInsetSource = {
6-
search: CompositionInsetSourceSearch;
5+
export type InjectedItemSource = {
6+
search: InjectedItemSourceSearch;
77
};

0 commit comments

Comments
 (0)