Change get_task parameter name

Author: alallema

meilisearch/client.py

@@ -79,13 +79,13 @@ def delete_index(self, uid: str) -> Dict[str, Any]:
 
         return self.http.delete(f'{self.config.paths.index}/{uid}')
 
-    def get_indexes(self, resource_query: Optional[Dict[str, Any]] = None) -> Dict[str, List[Index]]:
+    def get_indexes(self, parameters: 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
+        parameters (optional):
+            parameters accepted by the get indexes route: https://docs.meilisearch.com/reference/api/indexes.html#list-all-indexes
 
         Returns
         -------
@@ -97,10 +97,10 @@ def get_indexes(self, resource_query: Optional[Dict[str, Any]] = None) -> Dict[s
         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
         """
-        if resource_query is None:
-            resource_query = {}
+        if parameters is None:
+            parameters = {}
         response = self.http.get(
-            f'{self.config.paths.index}?{parse.urlencode(resource_query)}'
+            f'{self.config.paths.index}?{parse.urlencode(parameters)}'
         )
         response['results'] = [
                 Index(
@@ -114,13 +114,13 @@ def get_indexes(self, resource_query: Optional[Dict[str, Any]] = None) -> Dict[s
             ]
         return response
 
-    def get_raw_indexes(self, resource_query: Optional[Dict[str, Any]] = None) -> List[Dict[str, Any]]:
+    def get_raw_indexes(self, parameters: 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
+        parameters (optional):
+            parameters accepted by the get indexes route: https://docs.meilisearch.com/reference/api/indexes.html#list-all-indexes
 
         Returns
         -------
@@ -132,10 +132,10 @@ def get_raw_indexes(self, resource_query: Optional[Dict[str, Any]] = None) -> Li
         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
         """
-        if resource_query is None:
-            resource_query = {}
+        if parameters is None:
+            parameters = {}
         return self.http.get(
-            f'{self.config.paths.index}?{parse.urlencode(resource_query)}'
+            f'{self.config.paths.index}?{parse.urlencode(parameters)}'
         )
 
     def get_index(self, uid: str) -> Index:

tests/index/test_index.py

@@ -48,9 +48,9 @@ def test_get_indexes(client):
     assert len(response['results']) == 3
 
 @pytest.mark.usefixtures("indexes_sample")
-def test_get_indexes_with_resource_query(client):
+def test_get_indexes_with_parameters(client):
     """Tests getting all indexes."""
-    response = client.get_indexes(resource_query={'limit':1, 'offset': 1})
+    response = client.get_indexes(parameters={'limit':1, 'offset': 1})
     assert len(response['results']) == 1
 
 @pytest.mark.usefixtures("indexes_sample")
@@ -64,8 +64,8 @@ def test_get_raw_indexes(client):
     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})
+def test_get_raw_indexeswith_parameters(client):
+    response = client.get_raw_indexes(parameters={'limit':1, 'offset': 1})
     assert isinstance(response['results'], list)
     assert len(response['results']) == 1