Merge branch 'main' into enable-multi-modal

Author: awais786

.code-samples.meilisearch.yaml

@@ -781,3 +781,20 @@ search_parameter_reference_media_1: |-
           "limit": 3
       }
   )
+webhooks_get_1: |-
+  client.get_webhooks()
+webhooks_get_single_1: |-
+  client.get_webhook('WEBHOOK_UID')
+webhooks_post_1: |-
+  client.create_webhook({
+    'url': 'https://example.com/webhook',
+    'headers': {"Authorization":"", "X-Custom-Header":"test"},
+  })
+webhooks_patch_1: |-
+  client.update_webhook('WEBHOOK_UID', {
+    'url': 'https://example.com/new-webhook',
+    'headers': {"Authorization":"", "X-Custom-Header":"test"},
+  })
+webhooks_delete_1: |-
+  client.delete_webhook('WEBHOOK_UID')
+

meilisearch/client.py

@@ -32,6 +32,7 @@
 from meilisearch.index import Index
 from meilisearch.models.key import Key, KeysResults
 from meilisearch.models.task import Batch, BatchResults, Task, TaskInfo, TaskResults
+from meilisearch.models.webhook import Webhook, WebhooksResults
 from meilisearch.task import TaskHandler
 
 
@@ -465,6 +466,119 @@ def delete_key(self, key_or_uid: str) -> int:
 
         return response.status_code
 
+    # WEBHOOKS ROUTES
+
+    def get_webhooks(self) -> WebhooksResults:
+        """Get all webhooks.
+
+        Returns
+        -------
+        webhooks:
+            WebhooksResults instance containing list of webhooks and pagination info.
+            https://www.meilisearch.com/docs/reference/api/webhooks
+
+        Raises
+        ------
+        MeilisearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://www.meilisearch.com/docs/reference/errors/error_codes#meilisearch-errors
+        """
+        webhooks = self.http.get(f"{self.config.paths.webhooks}")
+        return WebhooksResults(**webhooks)
+
+    def get_webhook(self, webhook_uuid: str) -> Webhook:
+        """Get information about a specific webhook.
+
+        Parameters
+        ----------
+        webhook_uuid:
+            The uuid of the webhook to retrieve.
+
+        Returns
+        -------
+        webhook:
+            The webhook information.
+            https://www.meilisearch.com/docs/reference/api/webhooks#get-one-webhook
+
+        Raises
+        ------
+        MeilisearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://www.meilisearch.com/docs/reference/errors/error_codes#meilisearch-errors
+        """
+        webhook = self.http.get(f"{self.config.paths.webhooks}/{webhook_uuid}")
+        return Webhook(**webhook)
+
+    def create_webhook(self, options: Mapping[str, Any]) -> Webhook:
+        """Create a new webhook.
+
+        Parameters
+        ----------
+        options:
+            The webhook configuration. Can include:
+            - url: The URL to send the webhook to
+            - headers: Dictionary of HTTP headers to include in webhook requests
+
+        Returns
+        -------
+        webhook:
+            The newly created webhook.
+            https://www.meilisearch.com/docs/reference/api/webhooks#create-a-webhook
+
+        Raises
+        ------
+        MeilisearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://www.meilisearch.com/docs/reference/errors/error_codes#meilisearch-errors
+        """
+        webhook = self.http.post(self.config.paths.webhooks, options)
+        return Webhook(**webhook)
+
+    def update_webhook(self, webhook_uuid: str, options: Mapping[str, Any]) -> Webhook:
+        """Update an existing webhook.
+
+        Parameters
+        ----------
+        webhook_uuid:
+            The uuid of the webhook to update.
+        options:
+            The webhook fields to update. Can include:
+            - url: The URL to send the webhook to
+            - headers: Dictionary of HTTP headers to include in webhook requests
+
+        Returns
+        -------
+        webhook:
+            The updated webhook.
+            https://www.meilisearch.com/docs/reference/api/webhooks#update-a-webhook
+
+        Raises
+        ------
+        MeilisearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://www.meilisearch.com/docs/reference/errors/error_codes#meilisearch-errors
+        """
+        webhook = self.http.patch(f"{self.config.paths.webhooks}/{webhook_uuid}", options)
+        return Webhook(**webhook)
+
+    def delete_webhook(self, webhook_uuid: str) -> int:
+        """Delete a webhook.
+
+        Parameters
+        ----------
+        webhook_uuid:
+            The uuid of the webhook to delete.
+
+        Returns
+        -------
+        status_code:
+            The Response status code. 204 signifies a successful delete.
+            https://www.meilisearch.com/docs/reference/api/webhooks#delete-a-webhook
+
+        Raises
+        ------
+        MeilisearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://www.meilisearch.com/docs/reference/errors/error_codes#meilisearch-errors
+        """
+        response = self.http.delete(f"{self.config.paths.webhooks}/{webhook_uuid}")
+        return response.status_code
+
     def get_version(self) -> Dict[str, str]:
         """Get version Meilisearch
 

meilisearch/config.py

@@ -48,6 +48,7 @@ class Paths:
         edit = "edit"
         network = "network"
         experimental_features = "experimental-features"
+        webhooks = "webhooks"
 
     def __init__(
         self,

meilisearch/models/task.py

@@ -21,6 +21,7 @@ class Task(CamelBase):
     enqueued_at: datetime
     started_at: Optional[datetime] = None
     finished_at: Optional[datetime] = None
+    network: Optional[Dict[str, Any]] = None
 
     if is_pydantic_2():
 

meilisearch/models/webhook.py

@@ -0,0 +1,22 @@
+from typing import Any, Dict, List, Optional
+
+from camel_converter.pydantic_base import CamelBase
+from pydantic import ConfigDict
+
+
+class Webhook(CamelBase):
+    """Model for a Meilisearch webhook."""
+
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    uuid: str
+    url: str
+    headers: Optional[Dict[str, Any]] = None
+    isEditable: bool
+
+
+class WebhooksResults(CamelBase):
+    """Model for webhooks list results."""
+
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+    results: List[Webhook]

tests/client/test_client_multi_search_meilisearch.py

@@ -2,6 +2,7 @@
 
 from meilisearch.errors import MeilisearchApiError
 from tests.common import INDEX_UID, REMOTE_MS_1, REMOTE_MS_2
+from tests.test_utils import disable_sharding
 
 
 def test_basic_multi_search(client, empty_index):
@@ -84,14 +85,17 @@ def test_multi_search_with_network(client, index_with_documents):
     resp = client.add_or_update_networks(
         {
             "self": REMOTE_MS_1,
+            "sharding": True,
             "remotes": {
                 REMOTE_MS_1: {
                     "url": "http://ms-1235.example.meilisearch.io",
                     "searchApiKey": "xxxxxxxx",
+                    "writeApiKey": "xxxxxxxx",
                 },
                 REMOTE_MS_2: {
                     "url": "http://ms-1255.example.meilisearch.io",
                     "searchApiKey": "xxxxxxxx",
+                    "writeApiKey": "xxxxxxxx",
                 },
             },
         }
@@ -108,3 +112,4 @@ def test_multi_search_with_network(client, index_with_documents):
     assert response["hits"][0]["_federation"]["indexUid"] == INDEX_UID
     assert response["hits"][0]["_federation"]["remote"] == REMOTE_MS_1
     assert response["remoteErrors"] == {}
+    disable_sharding(client)

tests/client/test_client_network.py

@@ -1,6 +1,7 @@
 import pytest
 
 from tests.common import REMOTE_MS_1, REMOTE_MS_2
+from tests.test_utils import disable_sharding
 
 
 @pytest.mark.usefixtures("enable_network_options")
@@ -16,15 +17,27 @@ def test_add_or_update_networks(client):
     """Tests upsert network remote instance."""
     body = {
         "self": REMOTE_MS_1,
+        "sharding": True,
         "remotes": {
-            REMOTE_MS_1: {"url": "http://localhost:7700", "searchApiKey": "xxxxxxxxxxxxxx"},
-            REMOTE_MS_2: {"url": "http://localhost:7720", "searchApiKey": "xxxxxxxxxxxxxxx"},
+            REMOTE_MS_1: {
+                "url": "http://localhost:7700",
+                "searchApiKey": "xxxxxxxxxxxxxx",
+                "writeApiKey": "xxxxxxxxx",
+            },
+            REMOTE_MS_2: {
+                "url": "http://localhost:7720",
+                "searchApiKey": "xxxxxxxxxxxxxxx",
+                "writeApiKey": "xxxxxxxx",
+            },
         },
     }
     response = client.add_or_update_networks(body=body)
 
     assert isinstance(response, dict)
     assert response["self"] == REMOTE_MS_1
+    assert response["sharding"] is True
     assert len(response["remotes"]) >= 2
     assert REMOTE_MS_2 in response["remotes"]
     assert REMOTE_MS_1 in response["remotes"]
+
+    disable_sharding(client)

tests/client/test_client_sharding.py

@@ -0,0 +1,37 @@
+import pytest
+
+from tests.common import BASE_URL, REMOTE_MS_1
+from tests.test_utils import disable_sharding
+
+
+@pytest.mark.usefixtures("enable_network_options")
+def test_update_and_get_network_settings(client):
+    """Test updating and getting network settings."""
+    instance_name = REMOTE_MS_1
+    options = {
+        "self": instance_name,
+        "remotes": {
+            instance_name: {
+                "url": BASE_URL,
+                "searchApiKey": "search-key-1",
+                "writeApiKey": "write-key-1",
+            }
+        },
+        "sharding": True,
+    }
+
+    client.add_or_update_networks(options)
+    response = client.get_all_networks()
+
+    assert response["self"] == options["self"]
+    assert response["remotes"][instance_name]["url"] == options["remotes"][instance_name]["url"]
+    assert (
+        response["remotes"][instance_name]["searchApiKey"]
+        == options["remotes"][instance_name]["searchApiKey"]
+    )
+    assert (
+        response["remotes"][instance_name]["writeApiKey"]
+        == options["remotes"][instance_name]["writeApiKey"]
+    )
+    assert response["sharding"] == options["sharding"]
+    disable_sharding(client)