meilisearch-rust icon indicating copy to clipboard operation
meilisearch-rust copied to clipboard

Add support to the pagination setting customization at the index level

Open brunoocasali opened this issue 3 years ago • 1 comments

⚠️ 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:

  • parent issue: https://github.com/meilisearch/integration-guides/issues/205
  • engine issue: https://github.com/meilisearch/specifications/pull/157, https://github.com/meilisearch/meilisearch/issues/2495

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 avatar Jul 16 '22 18:07 brunoocasali

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

matthias-wright avatar Jul 25 '22 22:07 matthias-wright

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 avatar Aug 24 '22 17:08 bidoubiwa

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: |-

bidoubiwa avatar Aug 29 '22 10:08 bidoubiwa