refactor(specs): mutualise code between Search API & Comp API for search query parameters

[ClaraMuller]

🧭 What and Why

🎟 JIRA Ticket: Work preparation for https://algolia.atlassian.net/browse/CMP-484

Composition API team is preparing update of the API clients with writes endpoints (see full list of endpoints here).
Goals of this PR is to cleanup / refactor the current Open API spec to ease the integrations of the new endpoints.

Stack PRs:

• refactor(specs): group files for composition api #5122
• refactor(specs): add interface to manipulate query parameter between composition API & Search API #5123
• refactor(specs): mutualise code between Search API & Comp API for search query parameters #5125 <- This PR

Changes included:

Remove code duplication in file specs/composition-full/common/params/Search.yml where a lot of parameters where copy pasted from the files specs/common/schemas/SearchParams.yml & specs/common/schemas/IndexSettings.yml.

To achieve that, multiple schema has been extracted to make them available to be re-use directly.
Schemas have been extracted from the following objects:

• baseSearchParamsWithoutQuery in specs/common/schemas/SearchParams.yml
• indexSettingsAsSearchParams in specs/common/schemas/IndexSettings.yml

🧪 Test

• CI
• Locally run
  • yarn cli build specs all
  • yarn cli build clients javascript
  • yarn cli generate javascript
  • yarn cli generate go

[algolia-bot]

✔️ Code generated!

Name	Link
🪓 Triggered by	073ce86d5bf66057a2022cf19ed362c92f44d132
🍃 Generated commit	89a81e2d6bfd5826a626de04a285075ac424fc2c
🌲 Generated branch	generated/clara/refact/search-params-mutualised

📊 Benchmark results

Benchmarks performed on the method using a mock server, the results might not reflect the real-world performance.

Language	Req/s
go	1768
javascript	1605
php	1452
csharp	1215
python	1169
java	1009
ruby	796
swift	470
scala	23

[shortcuts]

All of those Enum suffix should be renamed to their original name (without the Enum), otherwise it changes the model generated and the import, which is a breaking change

[ClaraMuller]

Yes but what should be the good values ? The previous enum was using the name of the query parameter.
If I call the enum by the query parameter name, what should be the value to identify the query parameter ?

[shortcuts]

the generator only create a model for the enum, not the array of enum, so I think you can just name it AlternativesAsExact like before, no?

[ClaraMuller]

By putting the same values I have the following error:

/Users/clara.muller/workspace/repos-algolia/api-clients-automation/specs/common/schemas/IndexSettings.yml
  896:0  error  Parsing error: Map keys must be unique

[ClaraMuller]

I made a proposal in the last commit, tell me what do you think

[ClaraMuller]

yarn cli generate javascript is working locally

[ClaraMuller]

@Fluf22 @shortcuts Small ping on the PR.
I think we did not conclude of how to handle this conflict: #5125 (comment)

[gavinwade12]

@Fluf22 @shortcuts 👋 Clara handed this PR off to me before she left for PTO. I pushed a commit to fix the issue with her last commit, and the CI is green again. Could you please have another look? It seems like there was an unresolved comment: #5125 (comment)

[shortcuts]

that's a great cleanup!

[shortcuts]

i'm not sure what's the point of this file anymore if all it does is referencing the common specification, we could directly import the common ones instead of this one, no?

[shortcuts]

clean! gg