refactor(specs): add interface between Search and Composition #5277
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🧭 What and Why
What
This PR refactors the Composition API client specs to introduce a dedicated
Search.yml
file that aggregates all Search API resource references.Composition API should continue to expose resources from other clients as we plan to grow in API you can directly call. Having a clear separation of concern will make the evolution of the Composition API client easier.
Why
$ref
calls to Search API schemas in multiple files (all parameter that are shared between run and injection:filters
,hitsPerPage
, etc...).Changes included:
specs/composition-full/common/params/Search.yml
containing all Search API–related$ref
definitions used in Composition.Injection.yml
andRunParams.yml
to reference this new file instead of directly pointing tocommon/schemas/IndexSettings.yml
,common/schemas/SearchParams.yml
(the difference means nothing for Composition API) or complexe one likecommon/schemas/SearchParams.yml#/baseSearchParamsWithoutQuery/properties/facets
🧪 Test
yarn cli build specs all
yarn cli build clients javascript