Merge #504

504: Add support to the pagination setting customization r=alallema a=voloyev

# Pull Request

## What does this PR do?
Fixes #495 

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!


Co-authored-by: Volodymyr Yevtushenko <[email protected]>

Author: bors[bot]

meilisearch/config.py

@@ -27,6 +27,7 @@ class Paths():
         sortable_attributes = 'sortable-attributes'
         typo_tolerance = 'typo-tolerance'
         dumps = 'dumps'
+        pagination = 'pagination'
 
     def __init__(
         self,

meilisearch/index.py

@@ -1231,6 +1231,63 @@ def reset_typo_tolerance(self) -> Dict[str, Any]:
             self.__settings_url_for(self.config.paths.typo_tolerance),
         )
 
+    def get_pagination_settings(self) -> Dict[str, Any]:
+        """Get pagination settngs of the index.
+
+        Returns
+        -------
+        settings: dict
+            Dictionary containing the pagination settings of the index.
+
+        Raises
+        ------
+        MeiliSearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
+        """
+        return self.http.get(self.__settings_url_for(self.config.paths.pagination))
+
+    def update_pagination_settings(self, body: Dict[str, Any]) -> Dict[str, Any]:
+        """Update the pagination settings of the index.
+
+        Parameters
+        ----------
+        body: dict
+            Dictionary containing the pagination settings.
+            https://docs.meilisearch.com/reference/api/pagination.html#update-pagination-settings
+
+        Returns
+        -------
+        task:
+            Dictionary containing a task to track the informations about the progress of an asynchronous process.
+            https://docs.meilisearch.com/reference/api/tasks.html#get-one-task
+
+        Raises
+        ------
+        MeiliSearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
+        """
+        return self.http.patch(
+            path=self.__settings_url_for(self.config.paths.pagination),
+            body=body
+        )
+
+
+    def reset_pagination_settings(self) -> Dict[str, Any]:
+        """Reset pagination settings of the index to default values.
+
+        Returns
+        -------
+        task:
+            Dictionary containing a task to track the informations about the progress of an asynchronous process.
+            https://docs.meilisearch.com/reference/api/tasks.html#get-one-task
+
+        Raises
+        ------
+        MeiliSearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
+        """
+        return self.http.delete(self.__settings_url_for(self.config.paths.pagination))
+
     @staticmethod
     def _batch(
         documents: List[Dict[str, Any]], batch_size: int

tests/settings/test_settings_pagination.py

@@ -0,0 +1,31 @@
+DEFAULT_MAX_TOTAL_HITS = 1000
+NEW_MAX_TOTAL_HITS = {'maxTotalHits': 2222}
+
+
+def test_get_pagination_settings(empty_index):
+    response = empty_index().get_pagination_settings()
+
+    assert isinstance(response, dict)
+    assert { 'maxTotalHits': DEFAULT_MAX_TOTAL_HITS } == response
+
+
+def test_update_pagination_settings(empty_index):
+    index = empty_index()
+    response = index.update_pagination_settings(NEW_MAX_TOTAL_HITS)
+    assert isinstance(response, dict)
+    assert 'taskUid' in response
+
+    index.wait_for_task(response['taskUid'])
+    response = index.get_pagination_settings()
+    assert isinstance(response, dict)
+    assert NEW_MAX_TOTAL_HITS == response
+
+
+def test_delete_pagination_settings(empty_index):
+    index = empty_index()
+    response = index.reset_pagination_settings()
+
+    index.wait_for_task(response['taskUid'])
+    response = index.get_pagination_settings()
+    assert isinstance(response, dict)
+    assert { 'maxTotalHits': DEFAULT_MAX_TOTAL_HITS } == response