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 pagination setting customization at the index level #304

Closed
5 tasks
brunoocasali opened this issue Jul 16, 2022 · 3 comments · Fixed by #342
Closed
5 tasks

Add support to the pagination setting customization at the index level #304

brunoocasali opened this issue Jul 16, 2022 · 3 comments · Fixed by #342
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@brunoocasali
Copy link
Member

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

Related to:


Add a pagination index settings resource to manage customization of the maximum number of reachable documents during the search at the index level.

  • Expose pagination object on /indexes/:index_uid/settings endpoints.
  • Add GET/PATCH/DELETE - /indexes/:index_uid/settings/pagination endpoints.

The pagination object definition is made of the following properties:

  • maxTotalHits 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 pagination
    • GET /indexes/:index_uid/settings/pagination
    • PATCH /indexes/:index_uid/settings/pagination
    • DELETE /indexes/:index_uid/settings/pagination
  • Add tests
@brunoocasali brunoocasali added the good first issue Good for newcomers label Jul 16, 2022
@matthias-wright
Copy link

I would like to work on this. Is it still up for grabs?

@bidoubiwa bidoubiwa added the enhancement New feature or request label Aug 1, 2022
@bidoubiwa
Copy link
Contributor

Hey @matthias-wright, absolutely! Thanks and sorry for the late reply. Before you start, you have to wait until this PR #297 is merged

@bidoubiwa
Copy link
Contributor

From this list the following code-samples needs to be added as well:

  • get_pagination_settings_1: |-
  • update_pagination_settings_1: |-
  • reset_pagination_settings_1: |-
  • settings_guide_pagination_1: |-

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

Successfully merging a pull request may close this issue.

3 participants