[Meilisearch v1.50.0] Add Dynamic Search Rules (experimental)

[Strift]

Context

Meilisearch v1.50.0 introduces a revamped Dynamic Search Rules (also called "search rules") experimental feature. Search rules allow pinning documents at the top of search results when flexible, condition-based criteria are matched — such as matching query words, empty queries, or time windows.

This is an experimental feature and must be enabled via PATCH /experimental-features with {"dynamicSearchRules": true} before the endpoints are available.

Objective

Update the SDK to support the search rules API.

We want to expose the following endpoints:

• List rules: POST /dynamic-search-rules
• Get a rule: GET /dynamic-search-rules/{uid}
• Create or update a rule: PATCH /dynamic-search-rules/{uid} (upsert — returns an async task)
• Delete a rule: DELETE /dynamic-search-rules/{uid} (returns an async task)

For more information, consult:

• Search rules overview
• API reference — List rules
• API reference — Update/upsert a rule
• API reference — Delete a rule

Tasks

• Add methods for all four search rules endpoints (list, get, updateOrCreate, delete)
• Add test cases for all new methods, covering:
  • Listing rules (with pagination and filtering)
  • Retrieving a single rule by UID
  • Creating a new rule (upsert)
  • Updating an existing rule (upsert)
  • Deleting a rule
  • Ensuring that PATCH and DELETE correctly return and handle async tasks
• Update .code-samples.meilisearch.yaml to add examples under the following keys:
  • list_dynamic_search_rules_1 — it should match the equivalent documentation sample
  • get_dynamic_search_rule_1 — it should match the equivalent documentation sample
  • patch_dynamic_search_rule_1 — it should match the equivalent documentation sample
  • delete_dynamic_search_rule_1 — it should match the equivalent documentation sample

[NimishJais]

Hi! I'd like to work on adding the Dynamic Search Rules methods and tests. Could you please assign this issue to me?

[Strift]

Hello @NimishJais and thanks for your interest!

Feel free to open a PR for this, but we prefer not to assign issues. This sometimes discourages other contributors from opening a PR, and we've met users who asked to be assigned and never came back.

We are looking forward to reviewing your PR!

[NimishJais]

Got it, thanks for explaining the process! I'll dive into the codebase, implement the changes, and open a Pull Request.