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

Add support to the typo tolerance customization #288

Closed
5 tasks done
brunoocasali opened this issue Apr 11, 2022 · 3 comments · Fixed by #294
Closed
5 tasks done

Add support to the typo tolerance customization #288

brunoocasali opened this issue Apr 11, 2022 · 3 comments · Fixed by #294
Labels
good first issue Good for newcomers

Comments

@brunoocasali
Copy link
Member

brunoocasali commented Apr 11, 2022

⚠️ This issue is generated, it means the examples and the namings do not necessarily correspond to the language of this repository.
Also, if you are a maintainer, feel free to add any clarification and instruction about this issue.

Related to:


Add a typoTolerance index settings resource to manage customization of the typo tolerance feature at the index level.

  • Expose typoTolerance object on /indexes/:index_uid/settings endpoints.
  • Add GET/POST/DELETE - /indexes/:index_uid/settings/typo-tolerance endpoints.

The typoTolerance object definition is made of the following properties:

  • enabled type (boolean)
  • disableOnAttributes type (array[string])
  • disableOnWords type (array[string])
  • minWordSizeForTypos type (object)
    • oneTypo type (int)
    • twoTypos type (int)

More information about what each field does could be checked in the spec.

Check the other customization methods for reference like: synonyms, searchableAttributes, filterableAttributes.

TODO:

  • Add the new methods to customize typo-tolerance
    • GET /indexes/:index_uid/settings/typo-tolerance
    • POST /indexes/:index_uid/settings/typo-tolerance
    • DELETE /indexes/:index_uid/settings/typo-tolerance
  • Add tests
@brunoocasali brunoocasali added the good first issue Good for newcomers label Apr 11, 2022
@CatalinStratu
Copy link

Hello @brunoocasali, I'd like to handle this task. I think it's a good task for me to better understand the project.

@brunoocasali
Copy link
Member Author

Awesome @CatalinStratu 🎉

Since this typo customization is a new feature coming with the v0.27, and this package is not fully compatible yet with that version, to be possible to work on this issue, you should do this:

And don't hesitate to ask if you have any doubt!

Thanks for your help! ❤️

@alallema alallema linked a pull request May 2, 2022 that will close this issue
@alallema
Copy link
Contributor

alallema commented May 2, 2022

Hi @CatalinStratu,
Thank you for offering your help ❤️ . We are opening this issue in case we didn't have time to implement it during the pre-release. However, I had time to implement it. Feel to check it and do any comments!

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

Successfully merging a pull request may close this issue.

3 participants