Skip to content

fix(specs): add missing redirect property to rule consequence schema#5934

Merged
Fluf22 merged 2 commits intomainfrom
fix/search-consequence-redirect
Feb 11, 2026
Merged

fix(specs): add missing redirect property to rule consequence schema#5934
Fluf22 merged 2 commits intomainfrom
fix/search-consequence-redirect

Conversation

@Fluf22
Copy link
Copy Markdown
Collaborator

@Fluf22 Fluf22 commented Feb 6, 2026

🧭 What and Why

The consequence object in the Search API rules spec was missing the redirect property, which is used by "Redirect to Virtual Replica" rules. This caused all generated API clients to silently drop the redirect data during deserialization, producing empty consequences when round-tripping rules via SearchRules + SaveRules.

🎟 JIRA Ticket: CR-10356

Changes included:

  • update spec

The `consequence` object in the Search API rules spec was missing the
`redirect` property, which is used by "Redirect to Virtual Replica"
rules. This caused all generated API clients to silently drop the
redirect data during deserialization, producing empty consequences
when round-tripping rules via SearchRules + SaveRules.

CR-10356
@Fluf22 Fluf22 self-assigned this Feb 6, 2026
@algolia-bot
Copy link
Copy Markdown
Collaborator

algolia-bot commented Feb 6, 2026

✔️ Code generated!

Name Link
🪓 Triggered by eeb13d3adc9ba8dc179750284920d6d4b558d0c4
🍃 Generated commit e043cf80e5ab3986c7daf1138d72dd814ac4d515
🌲 Generated branch generated/fix/search-consequence-redirect
📊 Benchmark results

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

Language Req/s
javascript 2418
go 2217
php 1824
csharp 1484
python 1459
java 1166
ruby 954
swift 637
scala 23

@drodriguln
Copy link
Copy Markdown

Thanks for drafting this up!

But I'm confused given this feature has been working in beta for years. Was this property always missing here? How was this working before?

$ref: '../../../../common/parameters.yml#/objectID'
required:
- objectID
redirect:
Copy link
Copy Markdown

@drodriguln drodriguln Feb 6, 2026

Choose a reason for hiding this comment

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

lgtm. Something tells me you found the docs then.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I inferred what I put in the update from the API response 😁
But I wanted validation because I wasn't sure if other params were required or not
Thanks for the doc link anyway, I'll merge this PR!

@Fluf22
Copy link
Copy Markdown
Collaborator Author

Fluf22 commented Feb 9, 2026

Thanks for drafting this up!

But I'm confused given this feature has been working in beta for years. Was this property always missing here? How was this working before?

The indexName property was required only when the parent was specified
Maybe the customers leveraging this feature weren't using the latest version of the API clients

@Fluf22 Fluf22 marked this pull request as ready for review February 9, 2026 18:17
@Fluf22 Fluf22 requested a review from a team as a code owner February 9, 2026 18:17
@Fluf22 Fluf22 merged commit dfd9925 into main Feb 11, 2026
36 checks passed
@Fluf22 Fluf22 deleted the fix/search-consequence-redirect branch February 11, 2026 14:06
algolia-bot added a commit that referenced this pull request Feb 11, 2026
#5934) (generated) [skip ci]

Co-authored-by: Thomas Raffray <Fluf22@users.noreply.github.com>
algolia-bot added a commit to algolia/algoliasearch-client-csharp that referenced this pull request Feb 11, 2026
…a (generated)

algolia/api-clients-automation#5934

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Thomas Raffray <Fluf22@users.noreply.github.com>
algolia-bot added a commit to algolia/algoliasearch-client-dart that referenced this pull request Feb 11, 2026
…a (generated)

algolia/api-clients-automation#5934

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Thomas Raffray <Fluf22@users.noreply.github.com>
algolia-bot added a commit to algolia/algoliasearch-client-go that referenced this pull request Feb 11, 2026
…a (generated)

algolia/api-clients-automation#5934

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Thomas Raffray <Fluf22@users.noreply.github.com>
algolia-bot added a commit to algolia/algoliasearch-client-java that referenced this pull request Feb 11, 2026
…a (generated)

algolia/api-clients-automation#5934

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Thomas Raffray <Fluf22@users.noreply.github.com>
algolia-bot added a commit to algolia/algoliasearch-client-javascript that referenced this pull request Feb 11, 2026
…a (generated)

algolia/api-clients-automation#5934

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Thomas Raffray <Fluf22@users.noreply.github.com>
algolia-bot added a commit to algolia/algoliasearch-client-kotlin that referenced this pull request Feb 11, 2026
…a (generated)

algolia/api-clients-automation#5934

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Thomas Raffray <Fluf22@users.noreply.github.com>
algolia-bot added a commit to algolia/algoliasearch-client-php that referenced this pull request Feb 11, 2026
…a (generated)

algolia/api-clients-automation#5934

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Thomas Raffray <Fluf22@users.noreply.github.com>
algolia-bot added a commit to algolia/algoliasearch-client-python that referenced this pull request Feb 11, 2026
…a (generated)

algolia/api-clients-automation#5934

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Thomas Raffray <Fluf22@users.noreply.github.com>
algolia-bot added a commit to algolia/algoliasearch-client-ruby that referenced this pull request Feb 11, 2026
…a (generated)

algolia/api-clients-automation#5934

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Thomas Raffray <Fluf22@users.noreply.github.com>
algolia-bot added a commit to algolia/algoliasearch-client-scala that referenced this pull request Feb 11, 2026
…a (generated)

algolia/api-clients-automation#5934

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Thomas Raffray <Fluf22@users.noreply.github.com>
algolia-bot added a commit to algolia/algoliasearch-client-swift that referenced this pull request Feb 11, 2026
…a (generated)

algolia/api-clients-automation#5934

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Thomas Raffray <Fluf22@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