From f17c42cda04a737fb6fcfdca78f8a3b019d9ac3d Mon Sep 17 00:00:00 2001 From: gui machiavelli Date: Mon, 17 Nov 2025 14:23:55 +0100 Subject: [PATCH 1/2] add info on auth key redaction --- reference/api/settings.mdx | 2 +- reference/api/webhooks.mdx | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/reference/api/settings.mdx b/reference/api/settings.mdx index 6e355d52cd..96d311e1d6 100644 --- a/reference/api/settings.mdx +++ b/reference/api/settings.mdx @@ -2643,7 +2643,7 @@ This field is incompatible with `huggingFace` and `userProvided` embedders. ##### `apiKey` -Authentication token Meilisearch should send with each request to the embedder. +Authentication token Meilisearch should send with each request to the embedder. Meilisearch redacts this value when returning embedder settings. Do not use the redacted API key when updating settings. This field is mandatory if using a protected `rest` embedder. diff --git a/reference/api/webhooks.mdx b/reference/api/webhooks.mdx index 5b41807cc7..00611e3880 100644 --- a/reference/api/webhooks.mdx +++ b/reference/api/webhooks.mdx @@ -28,6 +28,7 @@ Use the `/webhooks` to trigger automatic workflows when Meilisearch finishes pro - `uuid`: a v4 uuid Meilisearch automatically generates when you create a new webhook - `url`: a string indication the URL Meilisearch should notify whenever it completes a task, required - `headers`: an object with HTTP headers and their values, optional, often used for authentication + - `Authorization` headers: the value of authorization headers is redacted in `webhook` responses. Do not use authorization header values as returned by Meilisearch to update a webhook - `isEditable`: read-only Boolean field indicating whether you can edit the webhook. Meilisearch automatically sets this to `true` for all webhooks created via the API and to `false` for reserved webhooks ## The webhook payload @@ -122,6 +123,8 @@ You can create up to 20 webhooks. Having multiple webhooks active at the same ti Update the configuration for the specified webhook. To remove a field, set its value to `null`. +When updating the `headers` field, Meilisearch only changes the headers you have explicitly submitted. All other headers remain unaltered. + It is not possible to edit webhooks whose `isEditable` field is set to `false`. From 06875fd6ed0483e367cc68359a7834185de396dd Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 17 Nov 2025 13:24:34 +0000 Subject: [PATCH 2/2] Update code samples [skip ci] --- snippets/samples/code_samples_get_documents_1.mdx | 5 ++++- snippets/samples/code_samples_get_documents_post_1.mdx | 3 ++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/snippets/samples/code_samples_get_documents_1.mdx b/snippets/samples/code_samples_get_documents_1.mdx index f391ceffa3..199e8fe7cc 100644 --- a/snippets/samples/code_samples_get_documents_1.mdx +++ b/snippets/samples/code_samples_get_documents_1.mdx @@ -13,7 +13,10 @@ client.index('movies').getDocuments({ ``` ```python Python -client.index('movies').get_documents({'limit':2, 'filter': 'genres=action'}) +client.index('movies').get_documents({ + 'limit':2, 'filter': 'genres=action', + 'sort': ['rating:desc', 'release_date:asc'] # list format +}) ``` ```php PHP diff --git a/snippets/samples/code_samples_get_documents_post_1.mdx b/snippets/samples/code_samples_get_documents_post_1.mdx index a507357f04..6fac124c55 100644 --- a/snippets/samples/code_samples_get_documents_post_1.mdx +++ b/snippets/samples/code_samples_get_documents_post_1.mdx @@ -23,7 +23,8 @@ client.index('books').getDocuments({ client.index('books').get_documents({ 'limit':3, 'fields': ['title', 'genres', 'rating', 'language'], - 'filter': '(rating > 3 AND (genres=Adventure OR genres=Fiction)) AND language=English' + 'filter': '(rating > 3 AND (genres=Adventure OR genres=Fiction)) AND language=English', + 'sort': 'rating:desc, title:asc' # comma-separated string format }) ```