Add resource query to indexes

Author: alallema

meilisearch/client.py

@@ -3,6 +3,7 @@
 import hmac
 import json
 import datetime
+from urllib import parse
 from typing import Any, Dict, List, Optional, Union
 from meilisearch.index import Index
 from meilisearch.config import Config
@@ -78,9 +79,14 @@ def delete_index(self, uid: str) -> Dict[str, Any]:
 
         return self.http.delete(f'{self.config.paths.index}/{uid}')
 
-    def get_indexes(self) -> List[Index]:
+    def get_indexes(self, resource_query: Optional[Dict[str, Any]] = None) -> Dict[str, List[Index]]:
         """Get all indexes.
 
+        Parameters
+        ----------
+        resource_query (optional):
+            resource_query accepted by the get indexes route: https://docs.meilisearch.com/reference/api/indexes.html#list-all-indexes
+
         Returns
         -------
         indexes:
@@ -91,10 +97,12 @@ def get_indexes(self) -> List[Index]:
         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
         """
-        response = self.http.get(self.config.paths.index)
-
-        return {
-            'results' : [
+        if resource_query is None:
+            resource_query = {}
+        response = self.http.get(
+            f'{self.config.paths.index}?{parse.urlencode(resource_query)}'
+        )
+        response['results'] = [
                 Index(
                     self.config,
                     index["uid"],
@@ -104,11 +112,16 @@ def get_indexes(self) -> List[Index]:
                 )
                 for index in response['results']
             ]
-        }
+        return response
 
-    def get_raw_indexes(self) -> List[Dict[str, Any]]:
+    def get_raw_indexes(self, resource_query: Optional[Dict[str, Any]] = None) -> List[Dict[str, Any]]:
         """Get all indexes in dictionary format.
 
+        Parameters
+        ----------
+        resource_query (optional):
+            resource_query accepted by the get indexes route: https://docs.meilisearch.com/reference/api/indexes.html#list-all-indexes
+
         Returns
         -------
         indexes:
@@ -119,7 +132,11 @@ def get_raw_indexes(self) -> List[Dict[str, Any]]:
         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.config.paths.index)
+        if resource_query is None:
+            resource_query = {}
+        return self.http.get(
+            f'{self.config.paths.index}?{parse.urlencode(resource_query)}'
+        )
 
     def get_index(self, uid: str) -> Index:
         """Get the index.

tests/index/test_index.py

@@ -41,21 +41,33 @@ def test_get_indexes(client):
     """Tests getting all indexes."""
     response = client.get_indexes()
     uids = [index.uid for index in response['results']]
-    assert isinstance(response, list)
+    assert isinstance(response['results'], list)
     assert common.INDEX_UID in uids
     assert common.INDEX_UID2 in uids
     assert common.INDEX_UID3 in uids
-    assert len(response) == 3
+    assert len(response['results']) == 3
+
+@pytest.mark.usefixtures("indexes_sample")
+def test_get_indexes_with_resource_query(client):
+    """Tests getting all indexes."""
+    response = client.get_indexes(resource_query={'limit':1, 'offset': 1})
+    assert len(response['results']) == 1
 
 @pytest.mark.usefixtures("indexes_sample")
 def test_get_raw_indexes(client):
-    response = client.get_raw_indexes()['results']
-    uids = [index['uid'] for index in response]
-    assert isinstance(response, list)
+    response = client.get_raw_indexes()
+    uids = [index['uid'] for index in response['results']]
+    assert isinstance(response['results'], list)
     assert common.INDEX_UID in uids
     assert common.INDEX_UID2 in uids
     assert common.INDEX_UID3 in uids
-    assert len(response) == 3
+    assert len(response['results']) == 3
+
+@pytest.mark.usefixtures("indexes_sample")
+def test_get_raw_indexeswith_resource_query(client):
+    response = client.get_raw_indexes(resource_query={'limit':1, 'offset': 1})
+    assert isinstance(response['results'], list)
+    assert len(response['results']) == 1
 
 def test_index_with_any_uid(client):
     index = client.index('anyUID')