Skip to content

Commit b63f9ac

Browse files
algolia-botFluf22
andcommitted
chore(website): exclude schema from generated variables file (generated)
algolia/api-clients-automation#5306 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Thomas Raffray <[email protected]>
1 parent a4ef9e2 commit b63f9ac

14 files changed

+105
-7
lines changed
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
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 { BaseInjectionQueryParameters } from './baseInjectionQueryParameters';
4+
import type { ExternalOrdering } from './externalOrdering';
5+
6+
export type External = {
7+
/**
8+
* Composition Index name.
9+
*/
10+
index: string;
11+
12+
params?: BaseInjectionQueryParameters | undefined;
13+
14+
ordering?: ExternalOrdering | undefined;
15+
};
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 { ExternalInjection } from './externalInjection';
4+
5+
export type ExternalInjectedItem = {
6+
items: Array<ExternalInjection>;
7+
};
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
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 ExternalInjection = {
4+
/**
5+
* An objectID injected into an external source.
6+
*/
7+
objectID: string;
8+
9+
/**
10+
* User-defined key-values that will be added to the injected item in the response. This is identical to Hits metadata defined in Composition or Composition Rule, with the benefit of being set at runtime.
11+
*/
12+
metadata?: { [key: string]: any } | undefined;
13+
};
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
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 ExternalOrdering = 'default' | 'userDefined';
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
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 { External } from './external';
4+
5+
/**
6+
* Injected items will originate from externally provided objectIDs (that must exist in the index) given at runtime in the run request payload.
7+
*/
8+
export type ExternalSource = {
9+
external: External;
10+
};

packages/client-composition/model/index.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ export * from './distinct';
3737
export * from './errorBase';
3838
export * from './exactOnSingleWordQuery';
3939
export * from './exhaustive';
40+
export * from './external';
41+
export * from './externalInjectedItem';
42+
export * from './externalInjection';
43+
export * from './externalOrdering';
44+
export * from './externalSource';
4045
export * from './facetFilters';
4146
export * from './facetHits';
4247
export * from './facetOrdering';
@@ -53,7 +58,6 @@ export * from './injectedItem';
5358
export * from './injectedItemHitsMetadata';
5459
export * from './injectedItemMetadata';
5560
export * from './injectedItemSource';
56-
export * from './injectedItemSourceSearch';
5761
export * from './injection';
5862
export * from './insideBoundingBox';
5963
export * from './listCompositionsResponse';
@@ -86,6 +90,7 @@ export * from './resultsInjectedItemInfoResponse';
8690
export * from './rulesBatchCompositionAction';
8791
export * from './rulesMultipleBatchRequest';
8892
export * from './rulesMultipleBatchResponse';
93+
export * from './search';
8994
export * from './searchCompositionRulesParams';
9095
export * from './searchCompositionRulesResponse';
9196
export * from './searchForFacetValuesParams';
@@ -97,6 +102,7 @@ export * from './searchPagination';
97102
export * from './searchResponse';
98103
export * from './searchResults';
99104
export * from './searchResultsItem';
105+
export * from './searchSource';
100106
export * from './snippetResult';
101107
export * from './snippetResultOption';
102108
export * from './sortRemainingBy';
Lines changed: 4 additions & 4 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 { InjectedItemSourceSearch } from './injectedItemSourceSearch';
3+
import type { ExternalSource } from './externalSource';
44

5-
export type InjectedItemSource = {
6-
search: InjectedItemSourceSearch;
7-
};
5+
import type { SearchSource } from './searchSource';
6+
7+
export type InjectedItemSource = SearchSource | ExternalSource;

packages/client-composition/model/params.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
import type { AroundPrecision } from './aroundPrecision';
44
import type { AroundRadius } from './aroundRadius';
5+
import type { ExternalInjectedItem } from './externalInjectedItem';
56
import type { FacetFilters } from './facetFilters';
67
import type { InsideBoundingBox } from './insideBoundingBox';
78
import type { NumericFilters } from './numericFilters';
@@ -120,4 +121,9 @@ export type Params = {
120121
* Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
121122
*/
122123
enableReRanking?: boolean | undefined;
124+
125+
/**
126+
* A list of extenrally injected objectID groups into from an external source.
127+
*/
128+
injectedItems?: { [key: string]: ExternalInjectedItem } | undefined;
123129
};

packages/client-composition/model/injectedItemSourceSearch.ts renamed to packages/client-composition/model/search.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
import type { BaseInjectionQueryParameters } from './baseInjectionQueryParameters';
44

5-
export type InjectedItemSourceSearch = {
5+
export type Search = {
66
/**
7-
* Composition Main Index name.
7+
* Composition Index name.
88
*/
99
index: string;
1010

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
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 { Search } from './search';
4+
5+
/**
6+
* Injected items will originate from a search request performed on the specified index.
7+
*/
8+
export type SearchSource = {
9+
search: Search;
10+
};

0 commit comments

Comments
 (0)