Merge pull request #491 from meilisearch/key_changes

Apply key pagination parameters

Author: alallema

meilisearch/client.py

@@ -262,9 +262,14 @@ def get_key(self, key_or_uid: str) -> Dict[str, Any]:
         """
         return self.http.get(f'{self.config.paths.keys}/{key_or_uid}')
 
-    def get_keys(self) -> Dict[str, Any]:
+    def get_keys(self, parameters: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
         """Gets the Meilisearch API keys.
 
+        Parameters
+        ----------
+        parameters (optional):
+            parameters accepted by the get keys route: https://docs.meilisearch.com/reference/api/keys.html#get-all-keys
+
         Returns
         -------
         keys:
@@ -276,7 +281,11 @@ def get_keys(self) -> 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.keys)
+        if parameters is None:
+            parameters = {}
+        return self.http.get(
+            f'{self.config.paths.keys}?{parse.urlencode(parameters)}'
+        )
 
     def create_key(
         self,

tests/client/test_client_key_meilisearch.py

@@ -13,6 +13,12 @@ def test_get_keys_default(client):
     assert keys['results'][0]['key'] is not None
     assert keys['results'][1]['key'] is not None
 
+def test_get_keys_with_parameters(client):
+    """Tests if search and admin keys have been generated and can be retrieved."""
+    keys = client.get_keys({'limit': 1})
+    assert isinstance(keys, dict)
+    assert len(keys['results']) == 1
+
 def test_get_key(client, test_key):
     """Tests if a key can be retrieved."""
     key = client.get_key(test_key['key'])
@@ -65,7 +71,7 @@ def test_update_keys(client, test_key_info):
     """Tests updating a key."""
     key = client.create_key(test_key_info)
     assert key['name'] == test_key_info['name']
-    update_key = client.update_key(key=key['key'], options={ 'name': 'keyTest' })
+    update_key = client.update_key(key_or_uid=key['key'], options={ 'name': 'keyTest' })
     assert update_key['key'] is not None
     assert update_key['expiresAt'] is None
     assert update_key['name'] == 'keyTest'