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

Fix facetFilters type #512

Open
aseure opened this issue Jan 14, 2019 · 0 comments
Open

Fix facetFilters type #512

aseure opened this issue Jan 14, 2019 · 0 comments

Comments

@aseure
Copy link

aseure commented Jan 14, 2019

The facetFilters parameter is currently typed as a Seq[String]. However, it can either be used as:

  • String
  • Seq[String]
  • Seq[Seq[String]]
  • Seq[?] where ? can be a composed of both Seq[String] or String

See our documentation for more details: https://www.algolia.com/doc/api-reference/api-parameters/facetFilters/.

Quick fix may be to introduce a new FacetFilters type to represent all those options but it's a breaking change and it would have to wait for another major release. We can also introduce a new field with this type and deprecate the original facetFilters fields but it would be misleading for the user not to use the actual Algolia parameter name.

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

No branches or pull requests

1 participant