Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion reference/api/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
3 changes: 3 additions & 0 deletions reference/api/webhooks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.

<Note>
It is not possible to edit webhooks whose `isEditable` field is set to `false`.

Expand Down
5 changes: 4 additions & 1 deletion snippets/samples/code_samples_get_documents_1.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion snippets/samples/code_samples_get_documents_post_1.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
})
```

Expand Down