[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

[fjbarrett]

I would like to work on this. I will follow the existing client/model conventions for all four endpoints, add request/response and async-task coverage, and synchronize the four code-sample keys with the documentation repository.

[fjbarrett]

I found a schema mismatch while verifying this against the released v1.50.0 binary (2ecfd54). The current documentation sample sends priority and an array-shaped conditions, but that payload is rejected with Unknown field priority: expected one of description, precedence, active, conditions, actions``. The released server accepts precedence and an object-shaped `conditions` (`query` / `time`) and returns the expected async task.

I will implement and test the SDK methods against the v1.50.0 server contract. For the requested patch_dynamic_search_rule_1 sample, should this PR reproduce the current documentation sample exactly, or use the payload accepted by v1.50.0?

[Strift]

It looks like meilisearch docs are outdated; your PR was good 👍

[sanders41]

It looks like meilisearch docs are outdated; your PR was good 👍

@Strift It's become fairly common for the documentation to be outdated or incompete. I'm assumming the faster releases and reduced team size has caused the documentation to suffer. It would be nice if they could be brought back to the level they used to be.