Skip to content

Commit f1f9d21

Browse files
ClaraMullerClaraMuller
committed
refactor(specs): add interface between Search and Composition
This reverts commit c004dd2.
1 parent aed3339 commit f1f9d21

File tree

3 files changed

+272
-75
lines changed

3 files changed

+272
-75
lines changed

‎specs/composition-full/common/params/Search.yml‎

Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,197 @@
1+
advancedSyntax:
2+
$ref: '../../../common/schemas/IndexSettings.yml#/advancedSyntax'
3+
4+
advancedSyntaxFeatures:
5+
$ref: '../../../common/schemas/IndexSettings.yml#/advancedSyntaxFeatures'
6+
7+
distinct:
8+
$ref: '../../../common/schemas/IndexSettings.yml#/distinct'
9+
10+
allowTyposOnNumericTokens:
11+
$ref: '../../../common/schemas/IndexSettings.yml#/allowTyposOnNumericTokens'
12+
13+
alternativesAsExact:
14+
$ref: '../../../common/schemas/IndexSettings.yml#/alternativesAsExact'
15+
16+
analytics:
17+
$ref: '../../../common/schemas/SearchParams.yml#/analytics'
18+
19+
analyticsTags:
20+
$ref: '../../../common/schemas/SearchParams.yml#/analyticsTags'
21+
22+
aroundLatLng:
23+
$ref: '../../../common/schemas/SearchParams.yml#/aroundLatLng'
24+
25+
aroundLatLngViaIP:
26+
$ref: '../../../common/schemas/SearchParams.yml#/aroundLatLngViaIP'
27+
28+
aroundPrecision:
29+
$ref: '../../../common/schemas/SearchParams.yml#/aroundPrecision'
30+
31+
aroundRadius:
32+
$ref: '../../../common/schemas/SearchParams.yml#/aroundRadius'
33+
34+
attributeCriteriaComputedByMinProximity:
35+
$ref: '../../../common/schemas/IndexSettings.yml#/attributeCriteriaComputedByMinProximity'
36+
37+
attributesToHighlight:
38+
$ref: '../../../common/schemas/IndexSettings.yml#/attributesToHighlight'
39+
40+
attributesToSnippet:
41+
$ref: '../../../common/schemas/IndexSettings.yml#/attributesToSnippet'
42+
43+
attributesToRetrieve:
44+
$ref: '../../../common/schemas/IndexSettings.yml#/attributesToRetrieve'
45+
46+
clickAnalytics:
47+
$ref: '../../../common/schemas/SearchParams.yml#/clickAnalytics'
48+
49+
disableExactOnAttributes:
50+
$ref: '../../../common/schemas/IndexSettings.yml#/disableExactOnAttributes'
51+
52+
decompoundQuery:
53+
$ref: '../../../common/schemas/IndexSettings.yml#/decompoundQuery'
54+
55+
disableTypoToleranceOnAttributes:
56+
$ref: '../../../common/schemas/IndexSettings.yml#/disableTypoToleranceOnAttributes'
57+
58+
enableABTest:
59+
$ref: '../../../common/schemas/SearchParams.yml#/enableABTest'
60+
61+
enablePersonalization:
62+
$ref: '../../../common/schemas/IndexSettings.yml#/enablePersonalization'
63+
64+
enableReRanking:
65+
$ref: '../../../common/schemas/IndexSettings.yml#/enableReRanking'
66+
67+
enableRules:
68+
$ref: '../../../common/schemas/IndexSettings.yml#/enableRules'
69+
70+
exactOnSingleWordQuery:
71+
$ref: '../../../common/schemas/IndexSettings.yml#/exactOnSingleWordQuery'
72+
73+
facets:
74+
$ref: '../../../common/schemas/SearchParams.yml#/baseSearchParamsWithoutQuery/properties/facets'
75+
76+
facetFilters:
77+
$ref: '../../../common/schemas/SearchParams.yml#/facetFilters'
78+
79+
facetingAfterDistinct:
80+
$ref: '../../../common/schemas/SearchParams.yml#/facetingAfterDistinct'
81+
82+
filters:
83+
$ref: '../../../common/schemas/SearchParams.yml#/filters'
84+
85+
getRankingInfo:
86+
$ref: '../../../common/schemas/SearchParams.yml#/getRankingInfo'
87+
88+
highlightPreTag:
89+
$ref: '../../../common/schemas/IndexSettings.yml#/highlightPreTag'
90+
91+
highlightPostTag:
92+
$ref: '../../../common/schemas/IndexSettings.yml#/highlightPostTag'
93+
94+
hitsPerPage:
95+
$ref: '../../../common/schemas/IndexSettings.yml#/hitsPerPage'
96+
97+
ignorePlurals:
98+
$ref: '../../../common/schemas/IndexSettings.yml#/ignorePlurals'
99+
100+
insideBoundingBox:
101+
$ref: '../../../common/schemas/SearchParams.yml#/insideBoundingBox'
102+
103+
insidePolygon:
104+
$ref: '../../../common/schemas/SearchParams.yml#/insidePolygon'
105+
106+
query:
107+
$ref: '../../../common/schemas/SearchParams.yml#/query'
108+
109+
queryLanguages:
110+
$ref: '../../../common/schemas/IndexSettings.yml#/queryLanguages'
111+
112+
queryType:
113+
$ref: '../../../common/schemas/IndexSettings.yml#/queryType'
114+
115+
length:
116+
$ref: '../../../common/schemas/SearchParams.yml#/length'
117+
118+
maxFacetHits:
119+
$ref: '../../../common/schemas/IndexSettings.yml#/maxFacetHits'
120+
121+
maxValuesPerFacet:
122+
$ref: '../../../common/schemas/IndexSettings.yml#/maxValuesPerFacet'
123+
124+
minimumAroundRadius:
125+
$ref: '../../../common/schemas/SearchParams.yml#/minimumAroundRadius'
126+
127+
minProximity:
128+
$ref: '../../../common/schemas/IndexSettings.yml#/minProximity'
129+
130+
minWordSizefor1Typo:
131+
$ref: '../../../common/schemas/IndexSettings.yml#/minWordSizefor1Typo'
132+
133+
minWordSizefor2Typos:
134+
$ref: '../../../common/schemas/IndexSettings.yml#/minWordSizefor2Typos'
135+
136+
naturalLanguages:
137+
$ref: '../../../common/schemas/SearchParams.yml#/naturalLanguages'
138+
139+
numericFilters:
140+
$ref: '../../../common/schemas/SearchParams.yml#/numericFilters'
141+
142+
optionalFilters:
143+
$ref: '../../../common/schemas/SearchParams.yml#/optionalFilters'
144+
145+
optionalWords:
146+
$ref: '../../../common/schemas/IndexSettings.yml#/optionalWords'
147+
148+
page:
149+
$ref: '../../../common/schemas/SearchParams.yml#/page'
150+
151+
percentileComputation:
152+
$ref: '../../../common/schemas/SearchParams.yml#/percentileComputation'
153+
154+
personalizationImpact:
155+
$ref: '../../../common/schemas/SearchParams.yml#/personalizationImpact'
156+
157+
relevancyStrictness:
158+
$ref: '../../../common/schemas/IndexSettings.yml#/relevancyStrictness'
159+
160+
removeStopWords:
161+
$ref: '../../../common/schemas/IndexSettings.yml#/removeStopWords'
162+
163+
removeWordsIfNoResults:
164+
$ref: '../../../common/schemas/IndexSettings.yml#/removeWordsIfNoResults'
165+
166+
replaceSynonymsInHighlight:
167+
$ref: '../../../common/schemas/IndexSettings.yml#/replaceSynonymsInHighlight'
168+
169+
responseFields:
170+
$ref: '../../../common/schemas/IndexSettings.yml#/responseFields'
171+
172+
restrictSearchableAttributes:
173+
$ref: '../../../common/schemas/SearchParams.yml#/restrictSearchableAttributes'
174+
175+
restrictHighlightAndSnippetArrays:
176+
$ref: '../../../common/schemas/IndexSettings.yml#/restrictHighlightAndSnippetArrays'
177+
178+
ruleContexts:
179+
$ref: '../../../common/schemas/SearchParams.yml#/ruleContexts'
180+
181+
sortFacetValuesBy:
182+
$ref: '../../../common/schemas/IndexSettings.yml#/sortFacetValuesBy'
183+
184+
snippetEllipsisText:
185+
$ref: '../../../common/schemas/IndexSettings.yml#/snippetEllipsisText'
186+
187+
sumOrFiltersScores:
188+
$ref: '../../../common/schemas/SearchParams.yml#/sumOrFiltersScores'
189+
190+
synonyms:
191+
$ref: '../../../common/schemas/SearchParams.yml#/synonyms'
192+
193+
userToken:
194+
$ref: '../../../common/schemas/SearchParams.yml#/userToken'
195+
196+
typoTolerance:
197+
$ref: '../../../common/schemas/IndexSettings.yml#/typoTolerance'

‎specs/composition-full/common/schemas/components/Injection.yml‎

Lines changed: 53 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -4,99 +4,99 @@ baseInjectionQueryParameters:
44
additionalProperties: false
55
properties:
66
advancedSyntax:
7-
$ref: '../../../../common/schemas/IndexSettings.yml#/advancedSyntax'
7+
$ref: '../../params/Search.yml#/advancedSyntax'
88
advancedSyntaxFeatures:
9-
$ref: '../../../../common/schemas/IndexSettings.yml#/advancedSyntaxFeatures'
9+
$ref: '../../params/Search.yml#/advancedSyntaxFeatures'
1010
allowTyposOnNumericTokens:
11-
$ref: '../../../../common/schemas/IndexSettings.yml#/allowTyposOnNumericTokens'
11+
$ref: '../../params/Search.yml#/allowTyposOnNumericTokens'
1212
alternativesAsExact:
13-
$ref: '../../../../common/schemas/IndexSettings.yml#/alternativesAsExact'
13+
$ref: '../../params/Search.yml#/alternativesAsExact'
1414
analytics:
15-
$ref: '../../../../common/schemas/SearchParams.yml#/analytics'
15+
$ref: '../../params/Search.yml#/analytics'
1616
attributeCriteriaComputedByMinProximity:
17-
$ref: '../../../../common/schemas/IndexSettings.yml#/attributeCriteriaComputedByMinProximity'
17+
$ref: '../../params/Search.yml#/attributeCriteriaComputedByMinProximity'
1818
attributesToHighlight:
19-
$ref: '../../../../common/schemas/IndexSettings.yml#/attributesToHighlight'
19+
$ref: '../../params/Search.yml#/attributesToHighlight'
2020
attributesToRetrieve:
21-
$ref: '../../../../common/schemas/IndexSettings.yml#/attributesToRetrieve'
21+
$ref: '../../params/Search.yml#/attributesToRetrieve'
2222
attributesToSnippet:
23-
$ref: '../../../../common/schemas/IndexSettings.yml#/attributesToSnippet'
23+
$ref: '../../params/Search.yml#/attributesToSnippet'
2424
clickAnalytics:
25-
$ref: '../../../../common/schemas/SearchParams.yml#/clickAnalytics'
25+
$ref: '../../params/Search.yml#/clickAnalytics'
2626
decompoundQuery:
27-
$ref: '../../../../common/schemas/IndexSettings.yml#/decompoundQuery'
27+
$ref: '../../params/Search.yml#/decompoundQuery'
2828
disableExactOnAttributes:
29-
$ref: '../../../../common/schemas/IndexSettings.yml#/disableExactOnAttributes'
29+
$ref: '../../params/Search.yml#/disableExactOnAttributes'
3030
disableTypoToleranceOnAttributes:
31-
$ref: '../../../../common/schemas/IndexSettings.yml#/disableTypoToleranceOnAttributes'
31+
$ref: '../../params/Search.yml#/disableTypoToleranceOnAttributes'
3232
distinct:
33-
$ref: '../../../../common/schemas/IndexSettings.yml#/distinct'
33+
$ref: '../../params/Search.yml#/distinct'
3434
enableABTest:
35-
$ref: '../../../../common/schemas/SearchParams.yml#/enableABTest'
35+
$ref: '../../params/Search.yml#/enableABTest'
3636
enablePersonalization:
37-
$ref: '../../../../common/schemas/IndexSettings.yml#/enablePersonalization'
37+
$ref: '../../params/Search.yml#/enablePersonalization'
3838
enableReRanking:
39-
$ref: '../../../../common/schemas/IndexSettings.yml#/enableReRanking'
39+
$ref: '../../params/Search.yml#/enableReRanking'
4040
enableRules:
41-
$ref: '../../../../common/schemas/IndexSettings.yml#/enableRules'
41+
$ref: '../../params/Search.yml#/enableRules'
4242
exactOnSingleWordQuery:
43-
$ref: '../../../../common/schemas/IndexSettings.yml#/exactOnSingleWordQuery'
43+
$ref: '../../params/Search.yml#/exactOnSingleWordQuery'
4444
facetFilters:
45-
$ref: '../../../../common/schemas/SearchParams.yml#/facetFilters'
45+
$ref: '../../params/Search.yml#/facetFilters'
4646
filters:
47-
$ref: '../../../../common/schemas/SearchParams.yml#/filters'
47+
$ref: '../../params/Search.yml#/filters'
4848
getRankingInfo:
49-
$ref: '../../../../common/schemas/SearchParams.yml#/getRankingInfo'
49+
$ref: '../../params/Search.yml#/getRankingInfo'
5050
highlightPostTag:
51-
$ref: '../../../../common/schemas/IndexSettings.yml#/highlightPostTag'
51+
$ref: '../../params/Search.yml#/highlightPostTag'
5252
highlightPreTag:
53-
$ref: '../../../../common/schemas/IndexSettings.yml#/highlightPreTag'
53+
$ref: '../../params/Search.yml#/highlightPreTag'
5454
ignorePlurals:
55-
$ref: '../../../../common/schemas/IndexSettings.yml#/ignorePlurals'
55+
$ref: '../../params/Search.yml#/ignorePlurals'
5656
maxFacetHits:
57-
$ref: '../../../../common/schemas/IndexSettings.yml#/maxFacetHits'
57+
$ref: '../../params/Search.yml#/maxFacetHits'
5858
minProximity:
59-
$ref: '../../../../common/schemas/IndexSettings.yml#/minProximity'
59+
$ref: '../../params/Search.yml#/minProximity'
6060
minWordSizefor1Typo:
61-
$ref: '../../../../common/schemas/IndexSettings.yml#/minWordSizefor1Typo'
61+
$ref: '../../params/Search.yml#/minWordSizefor1Typo'
6262
minWordSizefor2Typos:
63-
$ref: '../../../../common/schemas/IndexSettings.yml#/minWordSizefor2Typos'
63+
$ref: '../../params/Search.yml#/minWordSizefor2Typos'
6464
naturalLanguages:
65-
$ref: '../../../../common/schemas/SearchParams.yml#/naturalLanguages'
65+
$ref: '../../params/Search.yml#/naturalLanguages'
6666
numericFilters:
67-
$ref: '../../../../common/schemas/SearchParams.yml#/numericFilters'
67+
$ref: '../../params/Search.yml#/numericFilters'
6868
optionalFilters:
69-
$ref: '../../../../common/schemas/SearchParams.yml#/optionalFilters'
69+
$ref: '../../params/Search.yml#/optionalFilters'
7070
optionalWords:
71-
$ref: '../../../../common/schemas/IndexSettings.yml#/optionalWords'
71+
$ref: '../../params/Search.yml#/optionalWords'
7272
percentileComputation:
73-
$ref: '../../../../common/schemas/SearchParams.yml#/percentileComputation'
73+
$ref: '../../params/Search.yml#/percentileComputation'
7474
personalizationImpact:
75-
$ref: '../../../../common/schemas/SearchParams.yml#/personalizationImpact'
75+
$ref: '../../params/Search.yml#/personalizationImpact'
7676
queryLanguages:
77-
$ref: '../../../../common/schemas/IndexSettings.yml#/queryLanguages'
77+
$ref: '../../params/Search.yml#/queryLanguages'
7878
queryType:
79-
$ref: '../../../../common/schemas/IndexSettings.yml#/queryType'
79+
$ref: '../../params/Search.yml#/queryType'
8080
removeStopWords:
81-
$ref: '../../../../common/schemas/IndexSettings.yml#/removeStopWords'
81+
$ref: '../../params/Search.yml#/removeStopWords'
8282
removeWordsIfNoResults:
83-
$ref: '../../../../common/schemas/IndexSettings.yml#/removeWordsIfNoResults'
83+
$ref: '../../params/Search.yml#/removeWordsIfNoResults'
8484
replaceSynonymsInHighlight:
85-
$ref: '../../../../common/schemas/IndexSettings.yml#/replaceSynonymsInHighlight'
85+
$ref: '../../params/Search.yml#/replaceSynonymsInHighlight'
8686
responseFields:
87-
$ref: '../../../../common/schemas/IndexSettings.yml#/responseFields'
87+
$ref: '../../params/Search.yml#/responseFields'
8888
restrictHighlightAndSnippetArrays:
89-
$ref: '../../../../common/schemas/IndexSettings.yml#/restrictHighlightAndSnippetArrays'
89+
$ref: '../../params/Search.yml#/restrictHighlightAndSnippetArrays'
9090
restrictSearchableAttributes:
91-
$ref: '../../../../common/schemas/SearchParams.yml#/restrictSearchableAttributes'
91+
$ref: '../../params/Search.yml#/restrictSearchableAttributes'
9292
ruleContexts:
93-
$ref: '../../../../common/schemas/SearchParams.yml#/ruleContexts'
93+
$ref: '../../params/Search.yml#/ruleContexts'
9494
snippetEllipsisText:
95-
$ref: '../../../../common/schemas/IndexSettings.yml#/snippetEllipsisText'
95+
$ref: '../../params/Search.yml#/snippetEllipsisText'
9696
synonyms:
97-
$ref: '../../../../common/schemas/SearchParams.yml#/synonyms'
97+
$ref: '../../params/Search.yml#/synonyms'
9898
typoTolerance:
99-
$ref: '../../../../common/schemas/IndexSettings.yml#/typoTolerance'
99+
$ref: '../../params/Search.yml#/typoTolerance'
100100

101101
mainInjectionQueryParameters:
102102
title: Composition Main Injection Query parameters as object
@@ -108,17 +108,17 @@ mainInjectionQueryParameters:
108108
additionalProperties: false
109109
properties:
110110
facetingAfterDistinct:
111-
$ref: '../../../../common/schemas/SearchParams.yml#/facetingAfterDistinct'
111+
$ref: '../../params/Search.yml#/facetingAfterDistinct'
112112
facets:
113-
$ref: '../../../../common/schemas/SearchParams.yml#/baseSearchParamsWithoutQuery/properties/facets'
113+
$ref: '../../params/Search.yml#/facets'
114114
hitsPerPage:
115-
$ref: '../../../../common/schemas/IndexSettings.yml#/hitsPerPage'
115+
$ref: '../../params/Search.yml#/hitsPerPage'
116116
maxValuesPerFacet:
117-
$ref: '../../../../common/schemas/IndexSettings.yml#/maxValuesPerFacet'
117+
$ref: '../../params/Search.yml#/maxValuesPerFacet'
118118
sortFacetValuesBy:
119-
$ref: '../../../../common/schemas/IndexSettings.yml#/sortFacetValuesBy'
119+
$ref: '../../params/Search.yml#/sortFacetValuesBy'
120120
sumOrFiltersScores:
121-
$ref: '../../../../common/schemas/SearchParams.yml#/sumOrFiltersScores'
121+
$ref: '../../params/Search.yml#/sumOrFiltersScores'
122122

123123
injectedItemsQueryParameters:
124124
title: Composition injectedItems Query parameters as object

0 commit comments

Comments
 (0)