Apply documents changes

meilisearch/index.py

@@ -267,12 +267,12 @@ def get_documents(self, parameters: Optional[Dict[str, Any]] = None) -> List[Dic
         Parameters
         ----------
         parameters (optional):
-            parameters accepted by the get documents route: https://docs.meilisearch.com/reference/api/documents.html#get-all-documents
+            parameters accepted by the get documents route: https://docs.meilisearch.com/reference/api/documents.html#get-documents
 
         Returns
         -------
         document:
-            List of dictionaries containing the documents information.
+            Dictionary with limit, offset, total and results a list of dictionaries containing the documents information.
 
         Raises
         ------

tests/index/test_index_document_meilisearch.py

@@ -8,8 +8,8 @@
 def test_get_documents_default(empty_index):
     """Tests getting documents on a clean index."""
     response = empty_index().get_documents()
-    assert isinstance(response, list)
-    assert response == []
+    assert isinstance(response['results'], list)
+    assert response['results'] == []
 
 def test_add_documents(empty_index, small_movies):
     """Tests adding new documents to a clean index."""
@@ -36,7 +36,6 @@ def test_add_documents_in_batches(
     response = index.add_documents_in_batches(small_movies, batch_size, primary_key)
     assert ceil(len(small_movies) / batch_size) == len(response)
 
-    print(response, '\n', '\n')
     for r in response:
         assert 'uid' in r
         update = index.wait_for_task(r['uid'])
@@ -60,38 +59,38 @@ def test_get_document_inexistent(empty_index):
 def test_get_documents_populated(index_with_documents):
     """Tests getting documents from a populated index."""
     response = index_with_documents().get_documents()
-    assert isinstance(response, list)
-    assert len(response) == 20
+    assert isinstance(response['results'], list)
+    assert len(response['results']) == 20
 
 def test_get_documents_offset_optional_params(index_with_documents):
     """Tests getting documents from a populated index with optional parameters."""
     index = index_with_documents()
     response = index.get_documents()
-    assert isinstance(response, list)
-    assert len(response) == 20
+    assert isinstance(response['results'], list)
+    assert len(response['results']) == 20
     response_offset_limit = index.get_documents({
         'limit': 3,
         'offset': 1,
-        'attributesToRetrieve': 'title'
+        'fields': 'title'
     })
-    assert len(response_offset_limit) == 3
-    assert response_offset_limit[0]['title'] == response[1]['title']
+    assert len(response_offset_limit['results']) == 3
+    assert response_offset_limit['results'][0]['title'] == response['results'][1]['title']
 
 def test_update_documents(index_with_documents, small_movies):
     """Tests updating a single document and a set of documents."""
     index = index_with_documents()
     response = index.get_documents()
-    response[0]['title'] = 'Some title'
-    update = index.update_documents([response[0]])
+    response['results'][0]['title'] = 'Some title'
+    update = index.update_documents([response['results'][0]])
     assert isinstance(update, dict)
     assert 'uid' in update
     index.wait_for_task(update['uid'])
     response = index.get_documents()
-    assert response[0]['title'] == 'Some title'
+    assert response['results'][0]['title'] == 'Some title'
     update = index.update_documents(small_movies)
     index.wait_for_task(update['uid'])
     response = index.get_documents()
-    assert response[0]['title'] != 'Some title'
+    assert response['results'][0]['title'] != 'Some title'
 
 @pytest.mark.parametrize('batch_size', [2, 3, 1000])
 @pytest.mark.parametrize(
@@ -145,8 +144,8 @@ def test_delete_all_documents(index_with_documents):
     assert 'uid' in response
     index.wait_for_task(response['uid'])
     response = index.get_documents()
-    assert isinstance(response, list)
-    assert response == []
+    assert isinstance(response['results'], list)
+    assert response['results'] == []
 
 def test_add_documents_csv(empty_index, songs_csv):
     """Tests adding new documents to a clean index."""