Repository navigation
feat(specs): add resultCard to renderingContent widgets - #7084
Merged
Merged
Conversation
Contributor
π₯ 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.
|
Summary by Aikido
β‘ Enhancements
|
FabienMotte
marked this pull request as ready for review
September 30, 2026 12:06
FabienMotte
requested review from
Fluf22,
Haroenv and
MarioAlexandruDan
and
a balanced review from Copilot
September 30, 2026 12:06
There was a problem hiding this comment.
Copilot review overview
π’ Approval recommended
The schema propagation and language-specific registrations follow the established Banner model patterns.
Review effort: Balanced
Findings: None
What changed in this PR
Adds typed Result Card support to shared rendering widgets across generated API clients.
Changes:
- Defines the
resultCardwidget schema. - Exports
ResultCardfrom the JavaScript bundle. - Registers the shared model for Swift generation.
| File | Description |
|---|---|
specs/βcommon/βschemas/βIndexSettings.yml |
Adds the Result Card widget schema. |
templates/βjavascript/βclients/βalgoliasearch/βbuilds/βmodels.mustache |
Exports the generated JavaScript type. |
generators/βsrc/βmain/βjava/βcom/βalgolia/βcodegen/βAlgoliaSwiftGenerator.java |
Registers the shared Swift model name. |
π‘ Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Haroenv
approved these changes
Sep 30, 2026
Fluf22
approved these changes
Sep 30, 2026
algolia-api-clients-automation-bot Bot
added a commit
that referenced
this pull request
Sep 30, 2026
β¦rated) [skip ci] Co-authored-by: Fabien Motte <662153+FabienMotte@users.noreply.github.com>
algolia-api-clients-automation-bot Bot
added a commit
to algolia/algoliasearch-client-csharp
that referenced
this pull request
Sep 30, 2026
algolia/api-clients-automation#7084 Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com> Co-authored-by: Fabien Motte <662153+FabienMotte@users.noreply.github.com>
algolia-api-clients-automation-bot Bot
added a commit
to algolia/algoliasearch-client-dart
that referenced
this pull request
Sep 30, 2026
algolia/api-clients-automation#7084 Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com> Co-authored-by: Fabien Motte <662153+FabienMotte@users.noreply.github.com>
algolia-api-clients-automation-bot Bot
added a commit
to algolia/algoliasearch-client-go
that referenced
this pull request
Sep 30, 2026
algolia/api-clients-automation#7084 Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com> Co-authored-by: Fabien Motte <662153+FabienMotte@users.noreply.github.com>
algolia-api-clients-automation-bot Bot
added a commit
to algolia/algoliasearch-client-java
that referenced
this pull request
Sep 30, 2026
algolia/api-clients-automation#7084 Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com> Co-authored-by: Fabien Motte <662153+FabienMotte@users.noreply.github.com>
algolia-api-clients-automation-bot Bot
added a commit
to algolia/algoliasearch-client-javascript
that referenced
this pull request
Sep 30, 2026
algolia/api-clients-automation#7084 Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com> Co-authored-by: Fabien Motte <662153+FabienMotte@users.noreply.github.com>
algolia-api-clients-automation-bot Bot
added a commit
to algolia/algoliasearch-client-kotlin
that referenced
this pull request
Sep 30, 2026
algolia/api-clients-automation#7084 Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com> Co-authored-by: Fabien Motte <662153+FabienMotte@users.noreply.github.com>
algolia-api-clients-automation-bot Bot
added a commit
to algolia/algoliasearch-client-php
that referenced
this pull request
Sep 30, 2026
algolia/api-clients-automation#7084 Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com> Co-authored-by: Fabien Motte <662153+FabienMotte@users.noreply.github.com>
algolia-api-clients-automation-bot Bot
added a commit
to algolia/algoliasearch-client-python
that referenced
this pull request
Sep 30, 2026
algolia/api-clients-automation#7084 Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com> Co-authored-by: Fabien Motte <662153+FabienMotte@users.noreply.github.com>
algolia-api-clients-automation-bot Bot
added a commit
to algolia/algoliasearch-client-ruby
that referenced
this pull request
Sep 30, 2026
algolia/api-clients-automation#7084 Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com> Co-authored-by: Fabien Motte <662153+FabienMotte@users.noreply.github.com>
algolia-api-clients-automation-bot Bot
added a commit
to algolia/algoliasearch-client-scala
that referenced
this pull request
Sep 30, 2026
algolia/api-clients-automation#7084 Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com> Co-authored-by: Fabien Motte <662153+FabienMotte@users.noreply.github.com>
algolia-api-clients-automation-bot Bot
added a commit
to algolia/algoliasearch-client-swift
that referenced
this pull request
Sep 30, 2026
algolia/api-clients-automation#7084 Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com> Co-authored-by: Fabien Motte <662153+FabienMotte@users.noreply.github.com>
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
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: FX-3973
The InstantSearch Result Card is activated by a Rule consequence
{"renderingContent": {"widgets": {"resultCard": {"enabled": true}}}}(RFC). The engine and Metis already accept any widget name. In the spec, though,widgetshasadditionalProperties: falseand lists onlybanners. So typed clients can't writeresultCardin a Rule consequence and may drop it from search responses.Changes included:
resultCardwidget with anenabledboolean torenderingContent.widgets. The same schema is used for search responses and Rule consequence params.ResultCardin the shared models of the JSalgoliasearchbundle and the Swift generator, as forBanner.Related engine PR (rule metadata only, no merge-order constraint): https://github.com/algolia/AlgoliaSaaS/pull/15112
π§ͺ Test
yarn cli build specs searchpasses lint and validation. The generated clients come from CI.Written with Cursor agent.