diff --git a/specs/composition-full/common/params/Search.yml b/specs/composition-full/common/params/Search.yml new file mode 100644 index 00000000000..eadfae62605 --- /dev/null +++ b/specs/composition-full/common/params/Search.yml @@ -0,0 +1,197 @@ +advancedSyntax: + $ref: '../../../common/schemas/IndexSettings.yml#/advancedSyntax' + +advancedSyntaxFeatures: + $ref: '../../../common/schemas/IndexSettings.yml#/advancedSyntaxFeatures' + +distinct: + $ref: '../../../common/schemas/IndexSettings.yml#/distinct' + +allowTyposOnNumericTokens: + $ref: '../../../common/schemas/IndexSettings.yml#/allowTyposOnNumericTokens' + +alternativesAsExact: + $ref: '../../../common/schemas/IndexSettings.yml#/alternativesAsExact' + +analytics: + $ref: '../../../common/schemas/SearchParams.yml#/analytics' + +analyticsTags: + $ref: '../../../common/schemas/SearchParams.yml#/analyticsTags' + +aroundLatLng: + $ref: '../../../common/schemas/SearchParams.yml#/aroundLatLng' + +aroundLatLngViaIP: + $ref: '../../../common/schemas/SearchParams.yml#/aroundLatLngViaIP' + +aroundPrecision: + $ref: '../../../common/schemas/SearchParams.yml#/aroundPrecision' + +aroundRadius: + $ref: '../../../common/schemas/SearchParams.yml#/aroundRadius' + +attributeCriteriaComputedByMinProximity: + $ref: '../../../common/schemas/IndexSettings.yml#/attributeCriteriaComputedByMinProximity' + +attributesToHighlight: + $ref: '../../../common/schemas/IndexSettings.yml#/attributesToHighlight' + +attributesToSnippet: + $ref: '../../../common/schemas/IndexSettings.yml#/attributesToSnippet' + +attributesToRetrieve: + $ref: '../../../common/schemas/IndexSettings.yml#/attributesToRetrieve' + +clickAnalytics: + $ref: '../../../common/schemas/SearchParams.yml#/clickAnalytics' + +disableExactOnAttributes: + $ref: '../../../common/schemas/IndexSettings.yml#/disableExactOnAttributes' + +decompoundQuery: + $ref: '../../../common/schemas/IndexSettings.yml#/decompoundQuery' + +disableTypoToleranceOnAttributes: + $ref: '../../../common/schemas/IndexSettings.yml#/disableTypoToleranceOnAttributes' + +enableABTest: + $ref: '../../../common/schemas/SearchParams.yml#/enableABTest' + +enablePersonalization: + $ref: '../../../common/schemas/IndexSettings.yml#/enablePersonalization' + +enableReRanking: + $ref: '../../../common/schemas/IndexSettings.yml#/enableReRanking' + +enableRules: + $ref: '../../../common/schemas/IndexSettings.yml#/enableRules' + +exactOnSingleWordQuery: + $ref: '../../../common/schemas/IndexSettings.yml#/exactOnSingleWordQuery' + +facets: + $ref: '../../../common/schemas/SearchParams.yml#/baseSearchParamsWithoutQuery/properties/facets' + +facetFilters: + $ref: '../../../common/schemas/SearchParams.yml#/facetFilters' + +facetingAfterDistinct: + $ref: '../../../common/schemas/SearchParams.yml#/facetingAfterDistinct' + +filters: + $ref: '../../../common/schemas/SearchParams.yml#/filters' + +getRankingInfo: + $ref: '../../../common/schemas/SearchParams.yml#/getRankingInfo' + +highlightPreTag: + $ref: '../../../common/schemas/IndexSettings.yml#/highlightPreTag' + +highlightPostTag: + $ref: '../../../common/schemas/IndexSettings.yml#/highlightPostTag' + +hitsPerPage: + $ref: '../../../common/schemas/IndexSettings.yml#/hitsPerPage' + +ignorePlurals: + $ref: '../../../common/schemas/IndexSettings.yml#/ignorePlurals' + +insideBoundingBox: + $ref: '../../../common/schemas/SearchParams.yml#/insideBoundingBox' + +insidePolygon: + $ref: '../../../common/schemas/SearchParams.yml#/insidePolygon' + +query: + $ref: '../../../common/schemas/SearchParams.yml#/query' + +queryLanguages: + $ref: '../../../common/schemas/IndexSettings.yml#/queryLanguages' + +queryType: + $ref: '../../../common/schemas/IndexSettings.yml#/queryType' + +length: + $ref: '../../../common/schemas/SearchParams.yml#/length' + +maxFacetHits: + $ref: '../../../common/schemas/IndexSettings.yml#/maxFacetHits' + +maxValuesPerFacet: + $ref: '../../../common/schemas/IndexSettings.yml#/maxValuesPerFacet' + +minimumAroundRadius: + $ref: '../../../common/schemas/SearchParams.yml#/minimumAroundRadius' + +minProximity: + $ref: '../../../common/schemas/IndexSettings.yml#/minProximity' + +minWordSizefor1Typo: + $ref: '../../../common/schemas/IndexSettings.yml#/minWordSizefor1Typo' + +minWordSizefor2Typos: + $ref: '../../../common/schemas/IndexSettings.yml#/minWordSizefor2Typos' + +naturalLanguages: + $ref: '../../../common/schemas/SearchParams.yml#/naturalLanguages' + +numericFilters: + $ref: '../../../common/schemas/SearchParams.yml#/numericFilters' + +optionalFilters: + $ref: '../../../common/schemas/SearchParams.yml#/optionalFilters' + +optionalWords: + $ref: '../../../common/schemas/IndexSettings.yml#/optionalWords' + +page: + $ref: '../../../common/schemas/SearchParams.yml#/page' + +percentileComputation: + $ref: '../../../common/schemas/SearchParams.yml#/percentileComputation' + +personalizationImpact: + $ref: '../../../common/schemas/SearchParams.yml#/personalizationImpact' + +relevancyStrictness: + $ref: '../../../common/schemas/IndexSettings.yml#/relevancyStrictness' + +removeStopWords: + $ref: '../../../common/schemas/IndexSettings.yml#/removeStopWords' + +removeWordsIfNoResults: + $ref: '../../../common/schemas/IndexSettings.yml#/removeWordsIfNoResults' + +replaceSynonymsInHighlight: + $ref: '../../../common/schemas/IndexSettings.yml#/replaceSynonymsInHighlight' + +responseFields: + $ref: '../../../common/schemas/IndexSettings.yml#/responseFields' + +restrictSearchableAttributes: + $ref: '../../../common/schemas/SearchParams.yml#/restrictSearchableAttributes' + +restrictHighlightAndSnippetArrays: + $ref: '../../../common/schemas/IndexSettings.yml#/restrictHighlightAndSnippetArrays' + +ruleContexts: + $ref: '../../../common/schemas/SearchParams.yml#/ruleContexts' + +sortFacetValuesBy: + $ref: '../../../common/schemas/IndexSettings.yml#/sortFacetValuesBy' + +snippetEllipsisText: + $ref: '../../../common/schemas/IndexSettings.yml#/snippetEllipsisText' + +sumOrFiltersScores: + $ref: '../../../common/schemas/SearchParams.yml#/sumOrFiltersScores' + +synonyms: + $ref: '../../../common/schemas/SearchParams.yml#/synonyms' + +userToken: + $ref: '../../../common/schemas/SearchParams.yml#/userToken' + +typoTolerance: + $ref: '../../../common/schemas/IndexSettings.yml#/typoTolerance' diff --git a/specs/composition-full/common/schemas/components/Injection.yml b/specs/composition-full/common/schemas/components/Injection.yml index 99963d9a092..fd3d63d5f41 100644 --- a/specs/composition-full/common/schemas/components/Injection.yml +++ b/specs/composition-full/common/schemas/components/Injection.yml @@ -4,99 +4,99 @@ baseInjectionQueryParameters: additionalProperties: false properties: advancedSyntax: - $ref: '../../../../common/schemas/IndexSettings.yml#/advancedSyntax' + $ref: '../../params/Search.yml#/advancedSyntax' advancedSyntaxFeatures: - $ref: '../../../../common/schemas/IndexSettings.yml#/advancedSyntaxFeatures' + $ref: '../../params/Search.yml#/advancedSyntaxFeatures' allowTyposOnNumericTokens: - $ref: '../../../../common/schemas/IndexSettings.yml#/allowTyposOnNumericTokens' + $ref: '../../params/Search.yml#/allowTyposOnNumericTokens' alternativesAsExact: - $ref: '../../../../common/schemas/IndexSettings.yml#/alternativesAsExact' + $ref: '../../params/Search.yml#/alternativesAsExact' analytics: - $ref: '../../../../common/schemas/SearchParams.yml#/analytics' + $ref: '../../params/Search.yml#/analytics' attributeCriteriaComputedByMinProximity: - $ref: '../../../../common/schemas/IndexSettings.yml#/attributeCriteriaComputedByMinProximity' + $ref: '../../params/Search.yml#/attributeCriteriaComputedByMinProximity' attributesToHighlight: - $ref: '../../../../common/schemas/IndexSettings.yml#/attributesToHighlight' + $ref: '../../params/Search.yml#/attributesToHighlight' attributesToRetrieve: - $ref: '../../../../common/schemas/IndexSettings.yml#/attributesToRetrieve' + $ref: '../../params/Search.yml#/attributesToRetrieve' attributesToSnippet: - $ref: '../../../../common/schemas/IndexSettings.yml#/attributesToSnippet' + $ref: '../../params/Search.yml#/attributesToSnippet' clickAnalytics: - $ref: '../../../../common/schemas/SearchParams.yml#/clickAnalytics' + $ref: '../../params/Search.yml#/clickAnalytics' decompoundQuery: - $ref: '../../../../common/schemas/IndexSettings.yml#/decompoundQuery' + $ref: '../../params/Search.yml#/decompoundQuery' disableExactOnAttributes: - $ref: '../../../../common/schemas/IndexSettings.yml#/disableExactOnAttributes' + $ref: '../../params/Search.yml#/disableExactOnAttributes' disableTypoToleranceOnAttributes: - $ref: '../../../../common/schemas/IndexSettings.yml#/disableTypoToleranceOnAttributes' + $ref: '../../params/Search.yml#/disableTypoToleranceOnAttributes' distinct: - $ref: '../../../../common/schemas/IndexSettings.yml#/distinct' + $ref: '../../params/Search.yml#/distinct' enableABTest: - $ref: '../../../../common/schemas/SearchParams.yml#/enableABTest' + $ref: '../../params/Search.yml#/enableABTest' enablePersonalization: - $ref: '../../../../common/schemas/IndexSettings.yml#/enablePersonalization' + $ref: '../../params/Search.yml#/enablePersonalization' enableReRanking: - $ref: '../../../../common/schemas/IndexSettings.yml#/enableReRanking' + $ref: '../../params/Search.yml#/enableReRanking' enableRules: - $ref: '../../../../common/schemas/IndexSettings.yml#/enableRules' + $ref: '../../params/Search.yml#/enableRules' exactOnSingleWordQuery: - $ref: '../../../../common/schemas/IndexSettings.yml#/exactOnSingleWordQuery' + $ref: '../../params/Search.yml#/exactOnSingleWordQuery' facetFilters: - $ref: '../../../../common/schemas/SearchParams.yml#/facetFilters' + $ref: '../../params/Search.yml#/facetFilters' filters: - $ref: '../../../../common/schemas/SearchParams.yml#/filters' + $ref: '../../params/Search.yml#/filters' getRankingInfo: - $ref: '../../../../common/schemas/SearchParams.yml#/getRankingInfo' + $ref: '../../params/Search.yml#/getRankingInfo' highlightPostTag: - $ref: '../../../../common/schemas/IndexSettings.yml#/highlightPostTag' + $ref: '../../params/Search.yml#/highlightPostTag' highlightPreTag: - $ref: '../../../../common/schemas/IndexSettings.yml#/highlightPreTag' + $ref: '../../params/Search.yml#/highlightPreTag' ignorePlurals: - $ref: '../../../../common/schemas/IndexSettings.yml#/ignorePlurals' + $ref: '../../params/Search.yml#/ignorePlurals' maxFacetHits: - $ref: '../../../../common/schemas/IndexSettings.yml#/maxFacetHits' + $ref: '../../params/Search.yml#/maxFacetHits' minProximity: - $ref: '../../../../common/schemas/IndexSettings.yml#/minProximity' + $ref: '../../params/Search.yml#/minProximity' minWordSizefor1Typo: - $ref: '../../../../common/schemas/IndexSettings.yml#/minWordSizefor1Typo' + $ref: '../../params/Search.yml#/minWordSizefor1Typo' minWordSizefor2Typos: - $ref: '../../../../common/schemas/IndexSettings.yml#/minWordSizefor2Typos' + $ref: '../../params/Search.yml#/minWordSizefor2Typos' naturalLanguages: - $ref: '../../../../common/schemas/SearchParams.yml#/naturalLanguages' + $ref: '../../params/Search.yml#/naturalLanguages' numericFilters: - $ref: '../../../../common/schemas/SearchParams.yml#/numericFilters' + $ref: '../../params/Search.yml#/numericFilters' optionalFilters: - $ref: '../../../../common/schemas/SearchParams.yml#/optionalFilters' + $ref: '../../params/Search.yml#/optionalFilters' optionalWords: - $ref: '../../../../common/schemas/IndexSettings.yml#/optionalWords' + $ref: '../../params/Search.yml#/optionalWords' percentileComputation: - $ref: '../../../../common/schemas/SearchParams.yml#/percentileComputation' + $ref: '../../params/Search.yml#/percentileComputation' personalizationImpact: - $ref: '../../../../common/schemas/SearchParams.yml#/personalizationImpact' + $ref: '../../params/Search.yml#/personalizationImpact' queryLanguages: - $ref: '../../../../common/schemas/IndexSettings.yml#/queryLanguages' + $ref: '../../params/Search.yml#/queryLanguages' queryType: - $ref: '../../../../common/schemas/IndexSettings.yml#/queryType' + $ref: '../../params/Search.yml#/queryType' removeStopWords: - $ref: '../../../../common/schemas/IndexSettings.yml#/removeStopWords' + $ref: '../../params/Search.yml#/removeStopWords' removeWordsIfNoResults: - $ref: '../../../../common/schemas/IndexSettings.yml#/removeWordsIfNoResults' + $ref: '../../params/Search.yml#/removeWordsIfNoResults' replaceSynonymsInHighlight: - $ref: '../../../../common/schemas/IndexSettings.yml#/replaceSynonymsInHighlight' + $ref: '../../params/Search.yml#/replaceSynonymsInHighlight' responseFields: - $ref: '../../../../common/schemas/IndexSettings.yml#/responseFields' + $ref: '../../params/Search.yml#/responseFields' restrictHighlightAndSnippetArrays: - $ref: '../../../../common/schemas/IndexSettings.yml#/restrictHighlightAndSnippetArrays' + $ref: '../../params/Search.yml#/restrictHighlightAndSnippetArrays' restrictSearchableAttributes: - $ref: '../../../../common/schemas/SearchParams.yml#/restrictSearchableAttributes' + $ref: '../../params/Search.yml#/restrictSearchableAttributes' ruleContexts: - $ref: '../../../../common/schemas/SearchParams.yml#/ruleContexts' + $ref: '../../params/Search.yml#/ruleContexts' snippetEllipsisText: - $ref: '../../../../common/schemas/IndexSettings.yml#/snippetEllipsisText' + $ref: '../../params/Search.yml#/snippetEllipsisText' synonyms: - $ref: '../../../../common/schemas/SearchParams.yml#/synonyms' + $ref: '../../params/Search.yml#/synonyms' typoTolerance: - $ref: '../../../../common/schemas/IndexSettings.yml#/typoTolerance' + $ref: '../../params/Search.yml#/typoTolerance' mainInjectionQueryParameters: title: Composition Main Injection Query parameters as object @@ -108,17 +108,17 @@ mainInjectionQueryParameters: additionalProperties: false properties: facetingAfterDistinct: - $ref: '../../../../common/schemas/SearchParams.yml#/facetingAfterDistinct' + $ref: '../../params/Search.yml#/facetingAfterDistinct' facets: - $ref: '../../../../common/schemas/SearchParams.yml#/baseSearchParamsWithoutQuery/properties/facets' + $ref: '../../params/Search.yml#/facets' hitsPerPage: - $ref: '../../../../common/schemas/IndexSettings.yml#/hitsPerPage' + $ref: '../../params/Search.yml#/hitsPerPage' maxValuesPerFacet: - $ref: '../../../../common/schemas/IndexSettings.yml#/maxValuesPerFacet' + $ref: '../../params/Search.yml#/maxValuesPerFacet' sortFacetValuesBy: - $ref: '../../../../common/schemas/IndexSettings.yml#/sortFacetValuesBy' + $ref: '../../params/Search.yml#/sortFacetValuesBy' sumOrFiltersScores: - $ref: '../../../../common/schemas/SearchParams.yml#/sumOrFiltersScores' + $ref: '../../params/Search.yml#/sumOrFiltersScores' injectedItemsQueryParameters: title: Composition injectedItems Query parameters as object diff --git a/specs/composition-full/common/schemas/requestBodies/RunParams.yml b/specs/composition-full/common/schemas/requestBodies/RunParams.yml index 7955cd517ef..bdf7fb4a8ad 100644 --- a/specs/composition-full/common/schemas/requestBodies/RunParams.yml +++ b/specs/composition-full/common/schemas/requestBodies/RunParams.yml @@ -4,54 +4,54 @@ params: additionalProperties: false properties: query: - $ref: '../../../../common/schemas/SearchParams.yml#/query' + $ref: '../../params/Search.yml#/query' filters: - $ref: '../../../../common/schemas/SearchParams.yml#/filters' + $ref: '../../params/Search.yml#/filters' page: - $ref: '../../../../common/schemas/SearchParams.yml#/page' + $ref: '../../params/Search.yml#/page' getRankingInfo: $ref: '../../params/Composition.yml#/getRankingInfo' relevancyStrictness: - $ref: '../../../../common/schemas/IndexSettings.yml#/relevancyStrictness' + $ref: '../../params/Search.yml#/relevancyStrictness' facetFilters: - $ref: '../../../../common/schemas/SearchParams.yml#/facetFilters' + $ref: '../../params/Search.yml#/facetFilters' optionalFilters: - $ref: '../../../../common/schemas/SearchParams.yml#/optionalFilters' + $ref: '../../params/Search.yml#/optionalFilters' numericFilters: - $ref: '../../../../common/schemas/SearchParams.yml#/numericFilters' + $ref: '../../params/Search.yml#/numericFilters' hitsPerPage: - $ref: '../../../../common/schemas/IndexSettings.yml#/hitsPerPage' + $ref: '../../params/Search.yml#/hitsPerPage' aroundLatLng: - $ref: '../../../../common/schemas/SearchParams.yml#/aroundLatLng' + $ref: '../../params/Search.yml#/aroundLatLng' aroundLatLngViaIP: - $ref: '../../../../common/schemas/SearchParams.yml#/aroundLatLngViaIP' + $ref: '../../params/Search.yml#/aroundLatLngViaIP' aroundRadius: - $ref: '../../../../common/schemas/SearchParams.yml#/aroundRadius' + $ref: '../../params/Search.yml#/aroundRadius' aroundPrecision: - $ref: '../../../../common/schemas/SearchParams.yml#/aroundPrecision' + $ref: '../../params/Search.yml#/aroundPrecision' minimumAroundRadius: - $ref: '../../../../common/schemas/SearchParams.yml#/minimumAroundRadius' + $ref: '../../params/Search.yml#/minimumAroundRadius' insideBoundingBox: - $ref: '../../../../common/schemas/SearchParams.yml#/insideBoundingBox' + $ref: '../../params/Search.yml#/insideBoundingBox' insidePolygon: - $ref: '../../../../common/schemas/SearchParams.yml#/insidePolygon' + $ref: '../../params/Search.yml#/insidePolygon' queryLanguages: - $ref: '../../../../common/schemas/IndexSettings.yml#/queryLanguages' + $ref: '../../params/Search.yml#/queryLanguages' naturalLanguages: - $ref: '../../../../common/schemas/SearchParams.yml#/naturalLanguages' + $ref: '../../params/Search.yml#/naturalLanguages' enableRules: $ref: '../../params/Composition.yml#/enableRules' ruleContexts: $ref: '../../params/Composition.yml#/ruleContexts' userToken: - $ref: '../../../../common/schemas/SearchParams.yml#/userToken' + $ref: '../../params/Search.yml#/userToken' clickAnalytics: - $ref: '../../../../common/schemas/SearchParams.yml#/clickAnalytics' + $ref: '../../params/Search.yml#/clickAnalytics' analytics: - $ref: '../../../../common/schemas/SearchParams.yml#/analytics' + $ref: '../../params/Search.yml#/analytics' analyticsTags: - $ref: '../../../../common/schemas/SearchParams.yml#/analyticsTags' + $ref: '../../params/Search.yml#/analyticsTags' enableABTest: $ref: '../../params/Composition.yml#/enableABTest' enableReRanking: - $ref: '../../../../common/schemas/IndexSettings.yml#/enableReRanking' + $ref: '../../params/Search.yml#/enableReRanking' \ No newline at end of file