Changes regarding Meilisearch v0.30.0

[brunoocasali]

This issue gathers the changes related to the v0.30.0 of Meilisearch that will impact the integrations team.

Release date: November 28th, 2022

The whole milestone of v0.30.0 is here!

SDKs which should be finished by November 28th:

• C# (.NET)
• Go
• JavaScript
• PHP
• Python
• Ruby
• Rust
• Java
• Rails after Ruby release
• Symfony after PHP release
• DocsScraper after Python release
• Dart
• Swift

---

Add finite pagination in the search results

Related to:

• issue: Ease search result pagination meilisearch#2577
• spec: Search API - Page Selection Component specifications#196

Add the support to the new finite pagination in the /search requests. Check the according to issue and specification for more info.

Implementation references: meilisearch/meilisearch-dotnet#351, meilisearch/meilisearch-php#370, and meilisearch/meilisearch-js#1305

---

Cancel non-processed tasks with the new method /tasks/cancel

Related to:

• issue: Canceling tasks meilisearch#2749
• spec: Tasks API - Add task cancelation capability specifications#195

Allow users to cancel a processing or an enqueued task.

• Add new endpoint: POST /tasks/cancel
• Guarantee all the filters available in the GET /tasks but from and limit are available.
• Add new task type: taskCancelation
• Add new API key action: tasks.cancel
• Add new task status canceled
• Introduce a new error code missing_task_filters
• Task error field is set to null by default.
• EnqueuedTask canceledBy field is set to null by default.
• New fields in details from Task on taskCancelation task type:
  • matchedTasks
  • canceledTasks
  • originalQuery/originalFilter.

---

Add/Update filters for /tasks

Add filters for this endpoint:

• uids filter. e.g /tasks?uids=1,2,3,4
  • error code in case of failure: invalid_task_uids_filter
• canceledBy filter. e.g /tasks?canceledBy=99,100
  • error code in case of failure: invalid_task_canceled_by_filter
• beforeEnqueuedAt and afterEnqueuedAt. e.g /tasks?afterEnqueuedAt=2022-01-20&beforeEnqueuedAt=2022-01-23
• beforeStartedAt and afterStartedAt. e.g /tasks?afterStartedAt=2022-01-20&beforeStartedAt=2022-01-23
• beforeFinishedAt and afterFinishedAt. e.g /tasks?afterFinishedAt=2022-01-20&beforeFinishedAt=2022-01-23

Rename filters and error codes for this endpoint:

• indexUid query parameter is renamed indexUids
• type query parameter is renamed types
• status query parameter is renamed statuses
• invalid_task_type error is renamed invalid_task_types_filter
• invalid_task_status error is renamed invalid_task_statuses_filter

---

Index name swapping with the new method POST /swap-indexes

Related to:

• issue: Index swap meilisearch#2750
• spec: Swap Indexes API specifications#192

The goal of this issue is to make Meilisearch more production-ready by allowing the swap of indexes, and this feature should remove the possible downtimes.

• Add the POST /swap-indexes endpoint
• Add an indexSwap task type
• Add an indexes.swap API Key action
• Add a duplicate_index_found error.
• Add swaps in Tasks.details

---

Delete old and processed tasks

Related to:

• issue: Delete old processed tasks meilisearch#2751
• spec: Tasks API - Add task deletion capability specifications#198

This issue aims to reduce the users' friction with disk size management by allowing them to delete the old processed tasks.

• A new endpoint: DELETE /tasks
• A new task type: taskDeletion
• Add deletedTasks in field details from Task type when performing taskDeletion
• A new API key action: tasks.delete
• Guarantee all the filters available in the GET /tasks but from and limit are available.
• Add uids filter. e.g /tasks?uids=1,2,3,4 (⚠️ only effective after RC1)
  • error code in case of failure: invalid_task_uids_filter
• Add canceledBy filter. e.g /tasks?canceledBy=99,100
  • error code in case of failure: invalid_task_canceled_by_filter
• Add beforeEnqueuedAt and afterEnqueuedAt. e.g /tasks?afterEnqueuedAt=2022-01-20&beforeEnqueuedAt=2022-01-23
• Add beforeStartedAt and afterStartedAt. e.g /tasks?afterStartedAt=2022-01-20&beforeStartedAt=2022-01-23
• Add beforeFinishedAt and afterFinishedAt. e.g /tasks?afterFinishedAt=2022-01-20&beforeFinishedAt=2022-01-23

---

Add new error type missing_master_key

Related to:

• issue: Add new error when using /keys without having set a master-key before (missing_master_key) meilisearch#2918
• spec: Keys API - Indicate to users that a master key must be set at Meilisearch launch to use that feature  specifications#179

⚠️ Especially for strongly typed languages, check all the available error types.

---

Rename receivedDocumentsIds by matchedDocuments providedIds

Related to:

• issue: Rename receivedDocumentIds into matchedDocuments meilisearch#2799
• spec: Tasks API - Rename receivedDocumentsIds by providedIds specifications#188

⚠️ Especially for strongly typed languages, check the details field from the Task type.

---

Introduce the snapshotCreation task type

• issue: Introduce the snapshotCreation task type meilisearch#2953
• spec: Tasks API - Add task priority order section specifications#194

⚠️ Especially for strongly typed languages, check the type field of the Task type and add a new entry: snapshotCreation.

---

Remove batchUid from Task type (from 0.29)

• issue: Auto-batching: improve error handler + make it available by default meilisearch#2582
• spec: Auto-batching - Enable feature by default and remove unwanted options specifications#162

⚠️ Especially for strongly typed languages, remove the presence of batchUid field from the Task type.

[bidoubiwa]

Cancel

A new endpoint: POST /tasks/cancel

With the same query parameters as GET /tasks minus limit and from

Task error field is set to null by default.

Not sure this is related to the cancel API

A new task type: taskCancelation

Missing New Task.details on taskCancelation:

• matchedTasks
• canceledTasks
• originalQuery ⚠️ Name will be changed in future rc release to originalFilter (maybe rc1 or rc2)

Task canceledBy field is set to null by default.

canceledBy is returned in enqueuedTask (ex: post /documents) and task (ex: get /tasks/1)

Filters

• renames from singular to plural (ex: uid to uids) are only effective in rc1

Swap

Add an indexSwap task type

• Add swaps in Tasks.details

Flush old and processed tasks

• Rename flush to delete for consistency in wording across the specs
• Filters are missing, they extend the filters from GET /tasks minus from and limit
• add deletedTasks in Task.details when performing taskDeletion

[curquiza]

Docs-scraper can be updated to use index-swap! 😄 (breaking since it will require to use Meilisearch v0.30.0)

[bidoubiwa]

Introduce the snapshotCreation task type
issue: meilisearch/meilisearch#2953
spec: meilisearch/specifications#188

Not sure this is the correct spec

[brunoocasali]

Rename flush to delete for consistency in wording across the specs

@bidoubiwa can you explain that? Because in the Ruby and PHP there is no flush mention at all :)

[bidoubiwa]

Its just the title of your category here in this issue 😅