Add support to the pagination setting customization at the index level

[brunoocasali]

⚠️ 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: Changes regarding Meilisearch v0.28.0 integration-guides#205
• engine issue: Settings API - Customize the hard limits for pagination and faceting specifications#157, Add settings to customize the maximum number of reachable documents during the search meilisearch#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

[matthias-wright]

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

[bidoubiwa]

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]

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