refactor(specs): add interface to manipulate query parameter between composition API & Search API #5123
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
✔️ Code generated!
📊 Benchmark resultsBenchmarks performed on the method using a mock server, the results might not reflect the real-world performance.
|
ClaraMuller
force-pushed
the
clara/refact/group-files-in-dir
branch
from
3902472 to
14f3cbc
Compare
ClaraMuller
force-pushed
the
clara/refact/add-params-interface
branch
from
1b16d2c to
a561559
Compare
ClaraMuller
force-pushed
the
clara/refact/add-params-interface
branch
from
a561559 to
825c35d
Compare
shortcuts
reviewed
Jul 18, 2025
| @@ -0,0 +1,565 @@ | |||
| advancedSyntax: | |||
There was a problem hiding this comment.
this is the same as the index settings one, no? if so, we can import it
There was a problem hiding this comment.
This code duplication is legacy, check my next PR to see the final results
| type: array | ||
| items: | ||
| $ref: '../../../common/schemas/IndexSettings.yml#/advancedSyntaxFeatures' | ||
| description: | |
There was a problem hiding this comment.
same here the description is the same, is there a reason to duplicate it?
There was a problem hiding this comment.
This code duplication is legacy, check my next PR to see the final results
…composition API & Search API
ClaraMuller
force-pushed
the
clara/refact/add-params-interface
branch
from
825c35d to
aec0c49
Compare
|
After rebasing, I have an error on the Dart client, happy to have insights about how to fix it. |
|
seems to work locally after |
algolia-bot
added a commit
that referenced
this pull request
Jul 21, 2025
…composition API & Search API (#5123) (generated) [skip ci] Co-authored-by: Clara Muller <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
algolia-bot
added a commit
to algolia/algoliasearch-client-csharp
that referenced
this pull request
Jul 21, 2025
…composition API & Search API (generated) algolia/api-clients-automation#5123 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clara Muller <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
algolia-bot
added a commit
to algolia/algoliasearch-client-dart
that referenced
this pull request
Jul 21, 2025
…composition API & Search API (generated) algolia/api-clients-automation#5123 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clara Muller <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
algolia-bot
added a commit
to algolia/algoliasearch-client-go
that referenced
this pull request
Jul 21, 2025
…composition API & Search API (generated) algolia/api-clients-automation#5123 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clara Muller <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
algolia-bot
added a commit
to algolia/algoliasearch-client-java
that referenced
this pull request
Jul 21, 2025
…composition API & Search API (generated) algolia/api-clients-automation#5123 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clara Muller <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
algolia-bot
added a commit
to algolia/algoliasearch-client-javascript
that referenced
this pull request
Jul 21, 2025
…composition API & Search API (generated) algolia/api-clients-automation#5123 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clara Muller <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
algolia-bot
added a commit
to algolia/algoliasearch-client-kotlin
that referenced
this pull request
Jul 21, 2025
…composition API & Search API (generated) algolia/api-clients-automation#5123 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clara Muller <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
algolia-bot
added a commit
to algolia/algoliasearch-client-php
that referenced
this pull request
Jul 21, 2025
…composition API & Search API (generated) algolia/api-clients-automation#5123 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clara Muller <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
algolia-bot
added a commit
to algolia/algoliasearch-client-python
that referenced
this pull request
Jul 21, 2025
…composition API & Search API (generated) algolia/api-clients-automation#5123 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clara Muller <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
algolia-bot
added a commit
to algolia/algoliasearch-client-ruby
that referenced
this pull request
Jul 21, 2025
…composition API & Search API (generated) algolia/api-clients-automation#5123 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clara Muller <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
algolia-bot
added a commit
to algolia/algoliasearch-client-scala
that referenced
this pull request
Jul 21, 2025
…composition API & Search API (generated) algolia/api-clients-automation#5123 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clara Muller <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
algolia-bot
added a commit
to algolia/algoliasearch-client-swift
that referenced
this pull request
Jul 21, 2025
…composition API & Search API (generated) algolia/api-clients-automation#5123 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clara Muller <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
🎟 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.
Changes included:
Create directory
specs/composition-full/common/paramswith the files:Search.yml: dedicated to link toward the actual spec for Search API specs as the same parameters are expected to be usedComposition.ymlto store query parameter dedicated to Composition API that might differs from the Search API onesFile
specs/composition-full/common/params/Search.ymlallow to have a simple interface to always refer to in the spec for Composition API.This file is responsible to maintain the link between the Comp API specs and the Search API specs (see next step for handling code duplication) to avoid all the other parts of the Comp API specs to have to do it.
This file allow to refer every parameter for files
specs/composition-full/common/schemas/components/Injection.yml&specs/composition-full/common/schemas/requestBodies/RunParams.ymlto refer to directlySimplify file
specs/composition-full/common/schemas/components/Injection.ymlto have a better view of what parameter is allowed where.Stack PRs
Next steps
Mutualise code between Search API Client and Composition API client regarding query parameters.
Some are not yet exported to be referenced directly.
🧪 Test
yarn cli build specs allyarn cli build clients javascript