refactor(specs): add interface between Search and Composition #5277
+272
−75
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This reverts commit c004dd2.
No code generatedIf you believe code should've been generated, please, report the issue. 📊 Benchmark resultsBenchmarks performed on the method using a mock server, the results might not reflect the real-world performance.
|
shortcuts
approved these changes
Aug 29, 2025
Comment on lines
42
to
45
| enableRules: | ||
| $ref: '../../params/Composition.yml#/enableRules' | ||
| ruleContexts: | ||
| $ref: '../../params/Composition.yml#/ruleContexts' |
There was a problem hiding this comment.
should those, that are initially search parameters, but edited to match composition's requirement, also moved to that new Search.yml?
There was a problem hiding this comment.
As they are not related anymore to Search API client, I don't believe so.
The Search.yml file also contains the ref to the actual search query paramter that we used in other part of the composition API clients.
For these query paramater. available for run request for Composition, we want them to point to Composition specific parameters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.ymlfile 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
$refcalls 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.ymlcontaining all Search API–related$refdefinitions used in Composition.Injection.ymlandRunParams.ymlto 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 allyarn cli build clients javascript