Changes related to the next MeiliSearch release (v0.25.0)

.code-samples.meilisearch.yaml

@@ -12,6 +12,8 @@ create_an_index_1: |-
 update_an_index_1: |-
   client.index('movies').update(primary_key='movie_review_id')
 delete_an_index_1: |-
+  client.delete_index('movies')
+  // OR
   client.index('movies').delete()
 get_one_document_1: |-
   client.index('movies').get_document(25684)
@@ -39,12 +41,35 @@ delete_documents_1: |-
   client.index('movies').delete_documents([23488, 153738, 437035, 363869])
 search_post_1: |-
   client.index('movies').search('American ninja')
-get_update_1: |-
-  client.index('movies').get_update_status(1)
-get_all_updates_1: |-
-  client.index('movies').get_all_update_status()
-get_keys_1: |-
+get_task_by_index_1: |-
+  client.index('movies').get_task(1)
+get_all_tasks_1: |-
+  client.get_tasks()
+get_task_1: |-
+  client.get_task(1)
+get_all_tasks_by_index_1: |-
+  client.index('movies').get_tasks()
+get_one_key_1: |-
+  client.get_key('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4')
+get_all_keys_1: |-
   client.get_keys()
+create_a_key_1: |-
+  client.create_key(options={
+    'description': 'Add documents: Products API key',
+    'actions': ['documents.add'],
+    'indexes': ['products'],
+    'expiresAt': '2042-04-02T00:42:42Z'
+  })
+update_a_key_1: |-
+  client.update_key(key='d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4',
+    options={
+      'description': 'Manage documents: Products/Reviews API key',
+      'actions': ['documents.add', 'documents.delete'],
+      'indexes': ['products', 'reviews'],
+      'expiresAt': '2042-04-02T00:42:42Z'
+  })
+delete_a_key_1: |-
+  client.delete_key('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4')
 get_settings_1: |-
   client.index('movies').get_settings()
 update_settings_1: |-
@@ -423,3 +448,28 @@ geosearch_guide_sort_usage_2: |-
   client.index('restaurants').search('', {
     'sort': ['_geoPoint(48.8583701,2.2922926):asc', 'rating:desc']
   })
+security_guide_search_key_1: |-
+  client = Client('http://127.0.0.1:7700', 'apiKey')
+  client.index('patient_medical_records').search()
+security_guide_update_key_1: |-
+  client = Client('http://127.0.0.1:7700', 'masterKey')
+  client.update_key(key='d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4', options={
+    'indexes': ['doctors']
+  })
+security_guide_create_key_1: |-
+  client = Client('http://127.0.0.1:7700', 'masterKey')
+    client.create_key(options={
+    'description': 'Search patient records key',
+    'actions': ['search'],
+    'indexes': ['patient_medical_records'],
+    'expiresAt': '2023-01-01T00:00:00Z'
+  })
+security_guide_list_keys_1: |-
+  client = Client('http://127.0.0.1:7700', 'masterKey')
+  client.get_keys()
+security_guide_delete_key_1: |-
+  client = Client('http://127.0.0.1:7700', 'masterKey')
+  client.delete_key('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4')
+authorization_header_1: |-
+  client = Client('http://127.0.0.1:7700', 'masterKey')
+  client.get_keys()

README.md

@@ -87,10 +87,10 @@ documents = [
 ]
 
 # If the index 'movies' does not exist, MeiliSearch creates it when you first add the documents.
-index.add_documents(documents) # => { "updateId": 0 }
+index.add_documents(documents) # => { "uid": 0 }
 ```
 
-With the `updateId`, you can check the status (`enqueued`, `processing`, `processed` or `failed`) of your documents addition using the [update endpoint](https://docs.meilisearch.com/reference/api/updates.html#get-an-update-status).
+With the task `uid`, you can check the status (`enqueued`, `processing`, `succeeded` or `failed`) of your documents addition using the [task](https://docs.meilisearch.com/reference/api/tasks.html#get-task).
 
 #### Basic Search <!-- omit in toc -->
 
@@ -165,7 +165,7 @@ index.update_filterable_attributes([
 
 You only need to perform this operation once.
 
-Note that MeiliSearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [update status](https://docs.meilisearch.com/reference/api/updates.html#get-an-update-status).
+Note that MeiliSearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [task](https://docs.meilisearch.com/reference/api/tasks.html#get-task).
 
 Then, you can perform the search:
 
@@ -197,7 +197,7 @@ index.search(
 
 ## 🤖 Compatibility with MeiliSearch
 
-This package only guarantees the compatibility with the [version v0.24.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.24.0).
+This package only guarantees the compatibility with the [version v0.25.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.25.0).
 
 ## 💡 Learn More
 

meilisearch/_httprequests.py

@@ -12,7 +12,7 @@ class HttpRequests:
     def __init__(self, config: Config) -> None:
         self.config = config
         self.headers = {
-            'X-Meili-Api-Key': self.config.api_key,
+            'Authorization': f'Bearer {self.config.api_key}',
         }
 
     def send_request(
@@ -60,6 +60,14 @@ def post(
     ) -> Any:
         return self.send_request(requests.post, path, body, content_type)
 
+    def patch(
+        self,
+        path: str,
+        body: Optional[Union[Dict[str, Any], List[Dict[str, Any]], List[str], str]] = None,
+        content_type: Optional[str] = 'application/json',
+    ) -> Any:
+        return self.send_request(requests.patch, path, body, content_type)
+
     def put(
         self,
         path: str,