v0.28: Changes to Tasks API

[guimachiavelli]

With v0.28, a few changes have been introduced to the Tasks API:

Pagination

As the name states, users will get paginated results when using GET /tasks. This pagination will work differently from other routes (e.g. /keys, /documents) and depend on query parameters from, next, and limit. For more information on this decision, consult the spec or one of the indicated SMEs.

Filtering

Users will also be able to filter tasks by status, type, or index. These filters can be concatenated (?status=finished&indexUid=INDEX_UID) and a user can use a comma-separated list of values (?status=enqueued,processing).

According to current spec, it seems only AND operations (but not OR/NOT) are supported. Might be good to confirm this before beginning.

/indexes

Remove two endpoints, GET /indexes/:indexUid/tasks and GET /indexes/:indexUid/tasks/:taskUid

/tasks

Create one new endpoints to replace the ones removed from /indexes : GET /tasks?indexUid=:indexUid

Task types

• Task types documentPartial and documentAddition are renamed documentAdditionOrUpdate
• Task type clearAll is renamed documentDeletion

References

• Spec:
  • pagination: Tasks API - Seek/Keyset based pagination specifications#115
  • filtering: Tasks API - Filter tasks list by type/status/indexUid specifications#116
  • taskUid renaming: Tasks API - Rename uid to taskUid in the 202 - Accepted Summarized Task Response specifications#144
• Issue on core: Changes on /tasks endpoints meilisearch#2377
• SME: @Kerollmops

[dichotommy]

Also, uid in the summarized task response is renamed taskUid.

[maryamsulemani97]

Add new errors:

• invalid_task_status
• invalid_task_type