Repository navigation
feat(specs): add externalProvider source for CompAPI client - #7073
Conversation
💥 Breaking changes detected !!Either this PR or a previous PR not released yet introduced breaking changes, be careful when merging. ✔️ Code generated!
📊 Benchmark resultsBenchmarks performed on the method using a mock server, the results might not reflect the real-world performance.
|
|
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 |
externalProvider source for CompAPI client
| enum: ['default', 'providerDefined'] | ||
| default: 'providerDefined' |
There was a problem hiding this comment.
Should we also add userDefined as it's technically allowed?
There was a problem hiding this comment.
TBC with @aiordache but for the externalProvider source, providerDefined replace userDefined.
So it is not allowed
There was a problem hiding this comment.
providerDefined: Uses the ordering returned by the external provider. This corresponds to theuserDefinedordering forexternalsource types.
… (generated) [skip ci] Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>
…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>
…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>
…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>
…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>
…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>
…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>
…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>
…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>
…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>
…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>
…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>
🧭 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:
externalProvidersource type, usable as both the main source and an injected-item source (index,configurationID,configurationParams,params,ordering)externalProvider.configurationParamsto the Run request body, to override provider parameters at query timeerrorsfield 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 compositionbundles and lints cleanly with the new schemastests/CTS/requests/composition/{putComposition,putCompositionRule,search}.json.