fix(specs): cleanup for composition API clients #5119
Merged
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
Collaborator
✔️ 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/composition-private-client
branch
from
c84a624 to
a540f5d
Compare
ClaraMuller
changed the title
algolia-bot
added a commit
that referenced
this pull request
Jul 16, 2025
…skip ci] Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>
algolia-bot
added a commit
to algolia/algoliasearch-client-javascript
that referenced
this pull request
Jul 16, 2025
algolia/api-clients-automation#5119 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>
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:
For naming convention consistency Following files have been renamed to match (start with upper case)
specs/composition-full/common/schemas/BatchCompositionAction.ymlspecs/composition-full/common/schemas/CompositionBehavior.ymlspecs/composition-full/common/schemas/CompositionBehavior.ymlspecs/composition-full/common/schemas/ListCompositionsResponse.ymlspecs/composition-full/common/schemas/RulesBatchCompositionAction.ymlspecs/composition-full/common/schemas/CompositionRule.ymlExtract struct
CompositionfromListCompositionsResponse.ymltospecs/composition-full/common/schemas/Composition.ymlto make it reusable in a wider context.Fix incorrect input in
CompositionRule.ymlFix typos in
SearchParams.yml🧪 Test
yarn cli build specs allyarn cli build clients javascript