Skip to content

Commit 63c591d

Browse files
authored
refactor(specs): extract source object from behaviour object (#7074)
1 parent d59ce49 commit 63c591d

17 files changed

Lines changed: 405 additions & 347 deletions

‎specs/composition/common/schemas/components/CompositionBehavior.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ compositionInjectionBehavior:
1212
description: An object containing an `injection` behavior.
1313
properties:
1414
injection:
15-
$ref: './injection/Behaviour.yml#/injection'
15+
$ref: './behaviour/injection/Behaviour.yml#/injection'
1616
required:
1717
- injection
1818

@@ -22,6 +22,6 @@ compositionMultifeedBehavior:
2222
description: An object containing a `multifeed` behavior.
2323
properties:
2424
multifeed:
25-
$ref: './multifeed/Behaviour.yml#/multifeed'
25+
$ref: './behaviour/multifeed/Behaviour.yml#/multifeed'
2626
required:
2727
- multifeed
File renamed without changes.
File renamed without changes.
Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
injectedItemSearchSource:
2+
description: Injected items will originate from a search request performed on the specified index.
3+
x-discriminator-fields:
4+
- search
5+
type: object
6+
additionalProperties: false
7+
properties:
8+
search:
9+
$ref: '#/injectedItemSearch'
10+
required:
11+
- search
12+
13+
# Split out from injectedItemSearchSource because the custom
14+
# automation-custom/out-of-line-all-of lint rule requires allOf to be a
15+
# top-level schema, not nested inside `properties`.
16+
injectedItemSearch:
17+
type: object
18+
additionalProperties: false
19+
allOf:
20+
- $ref: '../../source/Search.yml#/baseSearchSource'
21+
- type: object
22+
additionalProperties: false
23+
properties:
24+
params:
25+
$ref: './SearchQueryParams.yml#/injectedItemsQueryParameters'
26+
27+
injectedItemExternalSource:
28+
description: Injected items will originate from externally provided objectIDs (that must exist in the index) given at runtime in the run request payload.
29+
x-discriminator-fields:
30+
- external
31+
type: object
32+
additionalProperties: false
33+
properties:
34+
external:
35+
$ref: '#/injectedItemExternal'
36+
required:
37+
- external
38+
39+
# Split out from injectedItemExternalSource because the custom
40+
# automation-custom/out-of-line-all-of lint rule requires allOf to be a
41+
# top-level schema, not nested inside `properties`.
42+
injectedItemExternal:
43+
type: object
44+
additionalProperties: false
45+
allOf:
46+
- $ref: '../../source/External.yml#/baseExternalSource'
47+
- type: object
48+
additionalProperties: false
49+
properties:
50+
params:
51+
$ref: './SearchQueryParams.yml#/injectedItemsQueryParameters'
52+
53+
injectedItemRecommendSource:
54+
description: Injected items will originate from a recommendation request performed on the specified index.
55+
x-discriminator-fields:
56+
- recommend
57+
type: object
58+
additionalProperties: false
59+
properties:
60+
recommend:
61+
$ref: '#/injectedItemRecommend'
62+
required:
63+
- recommend
64+
65+
# Split out from injectedItemRecommendSource because the custom
66+
# automation-custom/out-of-line-all-of lint rule requires allOf to be a
67+
# top-level schema, not nested inside `properties`.
68+
injectedItemRecommend:
69+
type: object
70+
additionalProperties: false
71+
allOf:
72+
- $ref: '../../source/Recommend.yml#/baseRecommendSource'
73+
- type: object
74+
additionalProperties: false
75+
properties:
76+
queryParameters:
77+
$ref: './SearchQueryParams.yml#/injectedItemsQueryParameters'
78+
fallbackParameters:
79+
$ref: './SearchQueryParams.yml#/injectedItemsQueryParameters'
80+
81+
injectedItemExternalProviderSource:
82+
description: Injected items will originate from a request to an external provider configuration.
83+
x-discriminator-fields:
84+
- externalProvider
85+
type: object
86+
additionalProperties: false
87+
properties:
88+
externalProvider:
89+
$ref: '#/injectedItemExternalProvider'
90+
required:
91+
- externalProvider
92+
93+
# Split out from injectedItemExternalProviderSource because the custom
94+
# automation-custom/out-of-line-all-of lint rule requires allOf to be a
95+
# top-level schema, not nested inside `properties`.
96+
injectedItemExternalProvider:
97+
type: object
98+
additionalProperties: false
99+
allOf:
100+
- $ref: '../../source/ExternalProvider.yml#/baseExternalProviderSource'
101+
- type: object
102+
additionalProperties: false
103+
properties:
104+
params:
105+
$ref: './SearchQueryParams.yml#/injectedItemsQueryParameters'
File renamed without changes.
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
injectionMainSearchSource:
2+
description: Organic result set will originate from a search request performed on the specified index.
3+
x-discriminator-fields:
4+
- search
5+
type: object
6+
additionalProperties: false
7+
properties:
8+
search:
9+
$ref: '#/injectionMainSearch'
10+
required:
11+
- search
12+
13+
# Split out from injectionMainSearchSource because the custom
14+
# automation-custom/out-of-line-all-of lint rule requires allOf to be a
15+
# top-level schema, not nested inside `properties`.
16+
injectionMainSearch:
17+
type: object
18+
additionalProperties: false
19+
allOf:
20+
- $ref: '../../source/Search.yml#/baseSearchSource'
21+
- type: object
22+
additionalProperties: false
23+
properties:
24+
params:
25+
$ref: './SearchQueryParams.yml#/mainInjectionQueryParameters'
26+
27+
injectionMainRecommendSource:
28+
description: Organic result set will originate from a recommend request.
29+
x-discriminator-fields:
30+
- recommend
31+
type: object
32+
additionalProperties: false
33+
properties:
34+
recommend:
35+
$ref: '#/injectionMainRecommend'
36+
required:
37+
- recommend
38+
39+
# Split out from injectionMainRecommendSource because the custom
40+
# automation-custom/out-of-line-all-of lint rule requires allOf to be a
41+
# top-level schema, not nested inside `properties`.
42+
injectionMainRecommend:
43+
type: object
44+
additionalProperties: false
45+
allOf:
46+
- $ref: '../../source/Recommend.yml#/baseRecommendSource'
47+
- type: object
48+
additionalProperties: false
49+
properties:
50+
queryParameters:
51+
$ref: './SearchQueryParams.yml#/mainInjectionQueryParameters'
52+
fallbackParameters:
53+
$ref: './SearchQueryParams.yml#/mainInjectionQueryParameters'
54+
55+
injectionMainExternalProviderSource:
56+
description: Organic result set will originate from a request to an external provider configuration.
57+
x-discriminator-fields:
58+
- externalProvider
59+
type: object
60+
additionalProperties: false
61+
properties:
62+
externalProvider:
63+
$ref: '#/injectionMainExternalProvider'
64+
required:
65+
- externalProvider
66+
67+
# Split out from injectionMainExternalProviderSource because the custom
68+
# automation-custom/out-of-line-all-of lint rule requires allOf to be a
69+
# top-level schema, not nested inside `properties`.
70+
injectionMainExternalProvider:
71+
type: object
72+
additionalProperties: false
73+
allOf:
74+
- $ref: '../../source/ExternalProvider.yml#/baseExternalProviderSource'
75+
- type: object
76+
additionalProperties: false
77+
properties:
78+
params:
79+
$ref: './SearchQueryParams.yml#/mainInjectionQueryParameters'
Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
baseInjectionQueryParameters:
2+
title: Composition common query parameters between main and injected items as object
3+
type: object
4+
additionalProperties: false
5+
properties:
6+
advancedSyntax:
7+
$ref: '../../../../params/Search.yml#/advancedSyntax'
8+
advancedSyntaxFeatures:
9+
$ref: '../../../../params/Search.yml#/advancedSyntaxFeatures'
10+
allowTyposOnNumericTokens:
11+
$ref: '../../../../params/Search.yml#/allowTyposOnNumericTokens'
12+
alternativesAsExact:
13+
$ref: '../../../../params/Search.yml#/alternativesAsExact'
14+
attributeCriteriaComputedByMinProximity:
15+
$ref: '../../../../params/Search.yml#/attributeCriteriaComputedByMinProximity'
16+
attributesToHighlight:
17+
$ref: '../../../../params/Search.yml#/attributesToHighlight'
18+
attributesToRetrieve:
19+
$ref: '../../../../params/Search.yml#/attributesToRetrieve'
20+
attributesToSnippet:
21+
$ref: '../../../../params/Search.yml#/attributesToSnippet'
22+
clickAnalytics:
23+
$ref: '../../../../params/Search.yml#/clickAnalytics'
24+
disableExactOnAttributes:
25+
$ref: '../../../../params/Search.yml#/disableExactOnAttributes'
26+
disableTypoToleranceOnAttributes:
27+
$ref: '../../../../params/Search.yml#/disableTypoToleranceOnAttributes'
28+
distinct:
29+
$ref: '../../../../params/Search.yml#/distinct'
30+
enableABTest:
31+
$ref: '../../../../params/Search.yml#/enableABTest'
32+
enablePersonalization:
33+
$ref: '../../../../params/Search.yml#/enablePersonalization'
34+
enableReRanking:
35+
$ref: '../../../../params/Search.yml#/enableReRanking'
36+
enableRules:
37+
$ref: '../../../../params/Search.yml#/enableRules'
38+
exactOnSingleWordQuery:
39+
$ref: '../../../../params/Search.yml#/exactOnSingleWordQuery'
40+
facetFilters:
41+
$ref: '../../../../params/Search.yml#/facetFilters'
42+
filters:
43+
$ref: '../../../../params/Search.yml#/filters'
44+
getRankingInfo:
45+
$ref: '../../../../params/Search.yml#/getRankingInfo'
46+
highlightPostTag:
47+
$ref: '../../../../params/Search.yml#/highlightPostTag'
48+
highlightPreTag:
49+
$ref: '../../../../params/Search.yml#/highlightPreTag'
50+
ignorePlurals:
51+
$ref: '../../../../params/Search.yml#/ignorePlurals'
52+
minProximity:
53+
$ref: '../../../../params/Search.yml#/minProximity'
54+
minWordSizefor1Typo:
55+
$ref: '../../../../params/Search.yml#/minWordSizefor1Typo'
56+
minWordSizefor2Typos:
57+
$ref: '../../../../params/Search.yml#/minWordSizefor2Typos'
58+
naturalLanguages:
59+
$ref: '../../../../params/Search.yml#/naturalLanguages'
60+
numericFilters:
61+
$ref: '../../../../params/Search.yml#/numericFilters'
62+
optionalFilters:
63+
$ref: '../../../../params/Search.yml#/optionalFilters'
64+
optionalWords:
65+
$ref: '../../../../params/Search.yml#/optionalWords'
66+
percentileComputation:
67+
$ref: '../../../../params/Search.yml#/percentileComputation'
68+
personalizationImpact:
69+
$ref: '../../../../params/Search.yml#/personalizationImpact'
70+
queryLanguages:
71+
$ref: '../../../../params/Search.yml#/queryLanguages'
72+
queryType:
73+
$ref: '../../../../params/Search.yml#/queryType'
74+
removeStopWords:
75+
$ref: '../../../../params/Search.yml#/removeStopWords'
76+
removeWordsIfNoResults:
77+
$ref: '../../../../params/Search.yml#/removeWordsIfNoResults'
78+
replaceSynonymsInHighlight:
79+
$ref: '../../../../params/Search.yml#/replaceSynonymsInHighlight'
80+
responseFields:
81+
$ref: '../../../../params/Search.yml#/responseFields'
82+
restrictHighlightAndSnippetArrays:
83+
$ref: '../../../../params/Search.yml#/restrictHighlightAndSnippetArrays'
84+
restrictSearchableAttributes:
85+
$ref: '../../../../params/Search.yml#/restrictSearchableAttributes'
86+
ruleContexts:
87+
$ref: '../../../../params/Search.yml#/ruleContexts'
88+
snippetEllipsisText:
89+
$ref: '../../../../params/Search.yml#/snippetEllipsisText'
90+
synonyms:
91+
$ref: '../../../../params/Search.yml#/synonyms'
92+
typoTolerance:
93+
$ref: '../../../../params/Search.yml#/typoTolerance'
94+
95+
mainInjectionQueryParameters:
96+
title: Composition Main Injection Query parameters as object
97+
type: object
98+
additionalProperties: false
99+
allOf:
100+
- $ref: '#/baseInjectionQueryParameters'
101+
- type: object
102+
additionalProperties: false
103+
properties:
104+
facetingAfterDistinct:
105+
$ref: '../../../../params/Search.yml#/facetingAfterDistinct'
106+
facets:
107+
$ref: '../../../../params/Composition.yml#/facets'
108+
hitsPerPage:
109+
$ref: '../../../../params/Search.yml#/hitsPerPage'
110+
maxValuesPerFacet:
111+
$ref: '../../../../params/Search.yml#/maxValuesPerFacet'
112+
renderingContent:
113+
$ref: '../../../../params/Search.yml#/renderingContent'
114+
sortFacetValuesBy:
115+
$ref: '../../../../params/Search.yml#/sortFacetValuesBy'
116+
sumOrFiltersScores:
117+
$ref: '../../../../params/Search.yml#/sumOrFiltersScores'
118+
119+
injectedItemsQueryParameters:
120+
title: Composition injectedItems Query parameters as object
121+
$ref: '#/baseInjectionQueryParameters'
File renamed without changes.

‎specs/composition/common/schemas/components/injection/ExternalProviderSource.yml‎

Lines changed: 0 additions & 6 deletions
This file was deleted.

0 commit comments

Comments
 (0)