Skip to content

feat(specs): add sortBy query param and sortingStrategy #5686

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

feat(specs): add sortBy query param and sortingStrategy #5686

wants to merge 10 commits into from
+112 −3

Conversation

@ben-kalmus
Copy link
Contributor

@ben-kalmus ben-kalmus commented Nov 27, 2025 •
edited by ClaraMuller
Loading

🧭 What and Why

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

Changes included:

  • Added new runtime query parameter to compositions run endpoint: "sortBy"
  • Added new setting to Composition schema "sortingStrategy" which allows defining new sorting indices.

Stacked PRs

🧪 Test

Added test for:

  • Upsert composition with sorting strategy
  • Run a composition with a sortBy runtime query param

@algolia-bot
Copy link
Collaborator

algolia-bot commented Nov 27, 2025 •
edited
Loading

✔️ Code generated!

Name Link
🪓 Triggered by 273133a38123f12b5631a034324149ea4c094f0e
🍃 Generated commit 340f18baafe4fe6ec38a69faafc77f941ec31af7
🌲 Generated branch generated/benk/sortby
📊 Benchmark results

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

Language Req/s
javascript 2610
go 2229
php 1982
csharp 1508
python 1389
java 1201
ruby 941
swift 317
scala 23

@ben-kalmus ben-kalmus changed the title feat: add sortBy query param and sortingStrategy feat(clients): add sortBy query param and sortingStrategy Nov 27, 2025
@ben-kalmus ben-kalmus changed the title feat(clients): add sortBy query param and sortingStrategy feat(specs): add sortBy query param and sortingStrategy Nov 27, 2025
@ben-kalmus ben-kalmus marked this pull request as ready for review November 27, 2025 15:19
@ben-kalmus ben-kalmus requested a review from a team as a code owner November 27, 2025 15:19
@ben-kalmus ben-kalmus requested review from Fluf22 and millotp November 27, 2025 15:19
@ClaraMuller
Copy link
Contributor

ClaraMuller commented Nov 28, 2025

Can you wait for this PR #5683 to be merged make sure it works ?

@ClaraMuller ClaraMuller requested a review from a team November 28, 2025 07:40
@ben-kalmus ben-kalmus mentioned this pull request Nov 28, 2025
Open
@ben-kalmus ben-kalmus force-pushed the benk/sortby branch 2 times, most recently from e9d8728 to 6f7519d Compare November 28, 2025 10:38
ClaraMuller
ClaraMuller requested changes Nov 28, 2025
View reviewed changes
Copy link
Contributor

@ClaraMuller ClaraMuller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remark about the documentation.
Let's keep it minimal at this point.
Feel free to put a better phrasing is there is one

@ClaraMuller ClaraMuller requested a review from a team November 28, 2025 10:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ClaraMuller ClaraMuller ClaraMuller approved these changes

@Fluf22 Fluf22 Awaiting requested review from Fluf22 Fluf22 is a code owner automatically assigned from algolia/api-clients-automation

@millotp millotp Awaiting requested review from millotp millotp is a code owner automatically assigned from algolia/api-clients-automation

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@ben-kalmus @algolia-bot @ClaraMuller