Skip to content

feat(specs): support algoliaDefined ordering in external sources - #7212

Merged
aiordache merged 2 commits into
mainfrom
aiordache/algolia-defined-ordering
Nov 4, 2026
Merged

aiordache merged 2 commits into
mainfrom
aiordache/algolia-defined-ordering

Conversation

@aiordache

Copy link
Copy Markdown
Contributor

🧭 What and Why

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

Changes included:

algoliaDefined ordering is introduced as the new default ordering for external sources. default is supported still.

  • List changes

🧪 Test

@aiordache
aiordache requested a review from a team as a code owner November 2, 2026 10:46
@algolia-api-clients-automation-bot

algolia-api-clients-automation-bot Bot commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

✔️ Code generated!

Name Link
🪓 Triggered by a0739851ba182ca43e94193deb4a9b14b9e63861
🍃 Generated commit 37a40b64768cae7451ca9a3ad94ed4f314c0a19c
🌲 Generated branch generated/aiordache/algolia-defined-ordering
📊 Benchmark results

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

Language Req/s
javascript 3787
php 2567
csharp 2040
go 1821
java 1746
python 1230
ruby 900
swift 842
scala 649

@aiordache aiordache changed the title support algoliaDefined ordering in external sources feat(specs): support algoliaDefined ordering in external sources Nov 2, 2026

@ClaraMuller ClaraMuller left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Don't document API you want to depracate.

JIRA ticket states:

Replace the default ordering option with the algoliaDefined to align with the internal changes.

enum: ['default', 'userDefined']
default: 'default'
description: Ordering to apply on the injected items coming from the external source. 'algoliaDefined' means the items will be ordered as they are in the index (natural relevance) in the smart group. 'default' is an alias to 'algoliaDefined'. 'userDefined' means the order in which the objectIDs are provided in the run request payload will be preserved in the smart group.
enum: ['default', 'algoliaDefined', 'userDefined']

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
enum: ['default', 'algoliaDefined', 'userDefined']
enum: ['algoliaDefined', 'userDefined']

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I believe the added test will fail if this is removed.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

As discussed, we cannot remove default from the enum yet as it will break marshalling of existing compositions with ordering set already to default. This should be done once we see the usage data.

@ClaraMuller
ClaraMuller requested a review from a team November 2, 2026 15:06
@aiordache
aiordache force-pushed the aiordache/algolia-defined-ordering branch from 750f197 to d2cb7b9 Compare November 4, 2026 13:08
@aiordache
aiordache requested a review from a team as a code owner November 4, 2026 13:08
@aiordache
aiordache force-pushed the aiordache/algolia-defined-ordering branch from d2cb7b9 to 55ba267 Compare November 4, 2026 13:16
Signed-off-by: Anca Iordache <809903+aiordache@users.noreply.github.com>
Signed-off-by: Anca Iordache <809903+aiordache@users.noreply.github.com>
@aiordache
aiordache force-pushed the aiordache/algolia-defined-ordering branch from 55ba267 to b4e93d1 Compare November 4, 2026 13:32
@aiordache
aiordache enabled auto-merge (squash) November 4, 2026 14:20
@aiordache
aiordache merged commit 8456d9e into main Nov 4, 2026
@aiordache
aiordache deleted the aiordache/algolia-defined-ordering branch November 4, 2026 15:23
algolia-api-clients-automation-bot Bot added a commit that referenced this pull request Nov 4, 2026
…7212) (generated) [skip ci]

Co-authored-by: Anca Iordache <809903+aiordache@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-csharp that referenced this pull request Nov 4, 2026
…enerated)

algolia/api-clients-automation#7212

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Anca Iordache <809903+aiordache@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-dart that referenced this pull request Nov 4, 2026
…enerated)

algolia/api-clients-automation#7212

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Anca Iordache <809903+aiordache@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-go that referenced this pull request Nov 4, 2026
…enerated)

algolia/api-clients-automation#7212

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Anca Iordache <809903+aiordache@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-java that referenced this pull request Nov 4, 2026
…enerated)

algolia/api-clients-automation#7212

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Anca Iordache <809903+aiordache@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-javascript that referenced this pull request Nov 4, 2026
…enerated)

algolia/api-clients-automation#7212

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Anca Iordache <809903+aiordache@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-kotlin that referenced this pull request Nov 4, 2026
…enerated)

algolia/api-clients-automation#7212

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Anca Iordache <809903+aiordache@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-php that referenced this pull request Nov 4, 2026
…enerated)

algolia/api-clients-automation#7212

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Anca Iordache <809903+aiordache@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-python that referenced this pull request Nov 4, 2026
…enerated)

algolia/api-clients-automation#7212

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Anca Iordache <809903+aiordache@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-ruby that referenced this pull request Nov 4, 2026
…enerated)

algolia/api-clients-automation#7212

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Anca Iordache <809903+aiordache@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-scala that referenced this pull request Nov 4, 2026
…enerated)

algolia/api-clients-automation#7212

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Anca Iordache <809903+aiordache@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-swift that referenced this pull request Nov 4, 2026
…enerated)

algolia/api-clients-automation#7212

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Anca Iordache <809903+aiordache@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants