feat(specs): add specific documentation for facets query parameter in Composition API #5477
Conversation
🪓 The generated code will be pushed at the end of the CI.Action triggered by commit Please do not push any generated code to this pull request. |
ClaraMuller force-pushed the clara/feat/doc-for-disjunctive-faceting branch from eb46180 to c2c73e5 Compare 
…in Composition API
ClaraMuller force-pushed the clara/feat/doc-for-disjunctive-faceting branch from c2c73e5 to c854cef Compare 
| # ### Category Faceting ### | ||
| # ######################### | ||
| | ||
| facets: |
There was a problem hiding this comment.
facets is already defined in the IndexSettings.yml file, and since it's imported in the composition spec, it will clash with this one and produce unpredictable naming, like IndexSettingsFacets.
It's not possible to override a model like that, either you would have to copy the entire IndexSettings.yml in here and edit the facets, or you need to rename this to something else like compositionFacets, but the facets object will still be generated with the other spec since it comes first.
There was a problem hiding this comment.
@millotp why does it workd for enableRules then ? It is exactly the same use case.
There was a problem hiding this comment.
if you take a look at the bundled spec it's the same issue, but by luck the one from composition was generated first for this one. I don't know how to control the order to prioritize the one from the composition spec
There was a problem hiding this comment.
Yes but the Search API client is not disturbed by the Composition one in that case ?
There was a problem hiding this comment.
the type is still generated because it's used inside of the BaseSearchResponse.
I think the only solution is to copy the common spec into the composition spec sorry
3 participants
🧭 What and Why
🎟 JIRA Ticket: https://algolia.atlassian.net/browse/CMP-594
Changes included:
facetsquery parameter with features that are only implemented within Composition API.For that, remove the link toward Search API doc and create a
facetssection within Composition API query parameter.runendpont as it is allowed in the payload🧪 Test
yarn cli build specs all && yarn cli build clients javascript