feat(specs): add specific documentation for facets query parameter in Composition API

[ClaraMuller]

🧭 What and Why

🎟 JIRA Ticket: https://algolia.atlassian.net/browse/CMP-594

Changes included:

• Enrich the documentation for facets query parameter with features that are only implemented within Composition API.
  For that, remove the link toward Search API doc and create a facets section within Composition API query parameter.
• Add this parameter as a potential value for run endpont as it is allowed in the payload

🧪 Test

• CI
• Run locally yarn cli build specs all && yarn cli build clients javascript

[algolia-bot]

🪓 The generated code will be pushed at the end of the CI.

Action triggered by commit e8b35cd1329d0d52db84f3fe5b492ea91c66d01b.

Please do not push any generated code to this pull request.

[millotp]

thats a tricky one !

[millotp]

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.

[ClaraMuller]

😭

[ClaraMuller]

@millotp why does it workd for enableRules then ? It is exactly the same use case.

[millotp]

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

[ClaraMuller]

Yes but the Search API client is not disturbed by the Composition one in that case ?

[millotp]

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