Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[v1.12.0] New index settings: facetSearch and prefixSearch #797

Open
10 tasks
Strift opened this issue Dec 31, 2024 · 2 comments
Open
10 tasks

[v1.12.0] New index settings: facetSearch and prefixSearch #797

Strift opened this issue Dec 31, 2024 · 2 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@Strift
Copy link
Contributor

Strift commented Dec 31, 2024

Following the changes related to Meilisearch v1.12.0 mega issue

Description

Add features introduced in Meilisearch v1.12.0: the facetSearch and prefixSearch index settings.

For more information refer to the docs:

For reference, here is how these methods were implemented in JavaScript within meilisearch-js:

// get prefix search settings
const settings = await client.index('myIndex').getPrefixSearch()
// disable prefix search
await client.index('myIndex').updatePrefixSearch('disabled')
// reset prefix search settings
await client.index('myIndex').resetPrefixSearch()

// get facet search settings
const settings = await client.index('myIndex').getFacetSearch()
// disable facet search
await client.index('myIndex').updateFacetSearch(false)
// reset facet search settings
await client.index('myIndex').resetFacetSearch()

Implementation

Tasks:

  • Add the relevant methods to configure facetSearch and prefixSearch index settings.
  • The methods associated with the /settings API route (to get, reset and update the settings globally) must be able to receive in the payload the new facetSearch and prefixSearch fields (in meilisearch-js, the equivalent methods are getSettings(), updateSettings(), and resetSettings())
  • ⚠️ Add integration tests ⚠️
  • Update the code samples in .code-samples.meilisearch.yaml to for the following keys, using the same example as their curl counterpart:
    • Add example for get_facet_search_settings_1
    • Add example for update_facet_search_settings_1
    • Add example for reset_facet_search_settings_1
    • Add example for get_prefix_search_settings_1
    • Add example for update_prefix_search_settings_1
    • Add example for reset_prefix_search_settings_1
@Strift Strift added enhancement New feature or request good first issue Good for newcomers labels Dec 31, 2024
@SczSca
Copy link

SczSca commented Jan 15, 2025

Hi there! Can you assign me this? I'll give it a try!

@curquiza
Copy link
Member

Hello @SczSca

Thanks for your interest in this project 🔥 You are definitely more than welcome to open a PR for this!

For your information, we prefer not assigning people to our issues because sometimes people ask to be assigned and never come back, which discourages the volunteer contributors from opening a PR to fix this issue.
We will accept and merge the first PR that fixes correctly and well implements the issue following our contributing guidelines.

We are looking forward to reviewing your PR 😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants