Skip to content

feat(specs): add resultCard to renderingContent widgets - #7084

Merged
Haroenv merged 1 commit into
mainfrom
feat/specs-result-card-widget
Sep 30, 2026
Merged

Haroenv merged 1 commit into
mainfrom
feat/specs-result-card-widget

Conversation

@FabienMotte

@FabienMotte FabienMotte commented Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

🧭 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, widgets has additionalProperties: false and lists only banners. So typed clients can't write resultCard in a Rule consequence and may drop it from search responses.

Changes included:

  • Add a resultCard widget with an enabled boolean to renderingContent.widgets. The same schema is used for search responses and Rule consequence params.
  • Register ResultCard in the shared models of the JS algoliasearch bundle and the Swift generator, as for Banner.

Related engine PR (rule metadata only, no merge-order constraint): https://github.com/algolia/AlgoliaSaaS/pull/15112

πŸ§ͺ Test

yarn cli build specs search passes lint and validation. The generated clients come from CI.

Written with Cursor agent.

@FabienMotte FabienMotte self-assigned this Sep 30, 2026
@algolia-api-clients-automation-bot

algolia-api-clients-automation-bot Bot commented Sep 30, 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 ba58e2996a9c28a754986b54a2f68382fa34cb08
πŸƒ Generated commit f7d720b5aa7361b31142c9a1dce7acdd8b190e6d
🌲 Generated branch generated/feat/specs-result-card-widget
πŸ“Š Benchmark results

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

Language Req/s
csharp 2590
go 2493
javascript 2123
php 1500
python 1234
java 1098
ruby 991
scala 663
swift 491

@aikido-pr-checks

Copy link
Copy Markdown

Summary by Aikido

Security Issues: 0 Quality Issues: 0 Resolved Issues: 0

⚑ Enhancements

  • Added ResultCard widget schema and registered it in generated client models

More info

@FabienMotte
FabienMotte marked this pull request as ready for review September 30, 2026 12:06
@FabienMotte
FabienMotte requested a review from a team as a code owner September 30, 2026 12:06
@FabienMotte
FabienMotte requested review from Fluf22, Haroenv and MarioAlexandruDan and a balanced review from Copilot September 30, 2026 12:06

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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 resultCard widget schema.
  • Exports ResultCard from 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
Haroenv merged commit b6cd822 into main Sep 30, 2026
41 checks passed
@Haroenv
Haroenv deleted the feat/specs-result-card-widget branch September 30, 2026 13:08
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>
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