Skip to content

feat(specs): add externalProvider source for CompAPI client - #7073

Merged
ClaraMuller merged 3 commits into
mainfrom
clara/feat/composition-api/add-external-provider-source
Sep 23, 2026
Merged

ClaraMuller merged 3 commits into
mainfrom
clara/feat/composition-api/add-external-provider-source

Conversation

@ClaraMuller

Copy link
Copy Markdown
Contributor

🧭 What and Why

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

Adds public API support for referencing external provider (e.g. Retail Media Network) configurations from Composition API sources, per the RFC External Provider Sources in Composition API.

Previously, compositions could only retrieve results via Algolia search & recommend. This lets customers delegate result retrieval to a configured external provider instead.

Changes included:

  • Add a new externalProvider source type, usable as both the main source and an injected-item source (index, configurationID, configurationParams, params, ordering)
  • Add externalProvider.configurationParams to the Run request body, to override provider parameters at query time
  • Add an errors field to the Run response, to surface non-critical processing errors (e.g. a provider failure that fell back to another result set)

🧪 Test

  • yarn cli build specs composition bundles and lints cleanly with the new schemas
  • Added CTS fixtures in tests/CTS/requests/composition/{putComposition,putCompositionRule,search}.json.

@algolia-api-clients-automation-bot

algolia-api-clients-automation-bot Bot commented Sep 22, 2026 •

Copy link
Copy Markdown
Contributor

💥 Breaking changes detected !!

Either this PR or a previous PR not released yet introduced breaking changes, be careful when merging.
You can find the details in the 'client java@21' CI job.

✔️ Code generated!

Name Link
🪓 Triggered by 9e9d16b0d71ead76266bb0f021afd080555fcd7c
🍃 Generated commit 00cf5868c4137a9871d0106eb143c67cb45d3412
🌲 Generated branch generated/clara/feat/composition-api/add-external-provider-source
📊 Benchmark results

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

Language Req/s
javascript 2976
go 1801
php 1578
csharp 1520
python 1243
java 948
ruby 929
swift 882
scala 692

@ClaraMuller ClaraMuller changed the title Clara/feat/composition api/add external provider source feat(specs): add externalProvider source for CompAPI client Sep 22, 2026
@ClaraMuller
ClaraMuller marked this pull request as ready for review September 22, 2026 15:45
@ClaraMuller
ClaraMuller requested review from a team as code owners September 22, 2026 15:45
@Fluf22

Fluf22 commented Sep 22, 2026

Copy link
Copy Markdown
Collaborator

Don't worry about the breaking change warning in the comment: it's coming from an older commit being included in the code generation commit

@ClaraMuller ClaraMuller changed the title feat(specs): add externalProvider source for CompAPI client feat(specs): add externalProvider source for CompAPI client Sep 23, 2026
Comment on lines +5 to +6
enum: ['default', 'providerDefined']
default: 'providerDefined'

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.

Should we also add userDefined as it's technically allowed?

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.

TBC with @aiordache but for the externalProvider source, providerDefined replace userDefined.
So it is not allowed

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.

providerDefined: Uses the ordering returned by the external provider. This corresponds to the userDefined ordering for external source types.

@ClaraMuller
ClaraMuller merged commit 4cab83c into main Sep 23, 2026
75 of 77 checks passed
@ClaraMuller
ClaraMuller deleted the clara/feat/composition-api/add-external-provider-source branch September 23, 2026 16:01
algolia-api-clients-automation-bot Bot added a commit that referenced this pull request Sep 23, 2026
… (generated) [skip ci]

Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-csharp that referenced this pull request Sep 23, 2026
…ted)

algolia/api-clients-automation#7073

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-dart that referenced this pull request Sep 23, 2026
…ted)

algolia/api-clients-automation#7073

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-go that referenced this pull request Sep 23, 2026
…ted)

algolia/api-clients-automation#7073

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-java that referenced this pull request Sep 23, 2026
…ted)

algolia/api-clients-automation#7073

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-javascript that referenced this pull request Sep 23, 2026
…ted)

algolia/api-clients-automation#7073

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-kotlin that referenced this pull request Sep 23, 2026
…ted)

algolia/api-clients-automation#7073

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-php that referenced this pull request Sep 23, 2026
…ted)

algolia/api-clients-automation#7073

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-python that referenced this pull request Sep 23, 2026
…ted)

algolia/api-clients-automation#7073

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-ruby that referenced this pull request Sep 23, 2026
…ted)

algolia/api-clients-automation#7073

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-scala that referenced this pull request Sep 23, 2026
…ted)

algolia/api-clients-automation#7073

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com>
Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>
algolia-api-clients-automation-bot Bot added a commit to algolia/algoliasearch-client-swift that referenced this pull request Sep 23, 2026
…ted)

algolia/api-clients-automation#7073

Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants