Tasks API - Add task cancelation capability

[alallema]

🤖 API Diff

---

Summary

This PR describes changes to welcome the task cancelation feature. It also adds consistency by specifying which task fields are displayed by default to null within a task resource.

---

Changes

• A new endpoint: POST /tasks/cancel

  • A new task type: taskCancelation
  • A new API key action: tasks.cancel
  • A new task status canceled

• Introduce a new error code missing_task_filters

• uids filter. e.g /tasks?uids=1,2,3,4

  • Introduce a new error code invalid_task_uids_filter

• canceledBy filter. e.g tasks?canceledBy=99,100

  • Introduce a new error code invalid_task_canceled_by_filter

• Introduce date filters:

  • Introduce a new error code invalid_task_date_filter
  • beforeEnqueuedAt/afterEnqueuedAt filter.
  • beforeStartedAt/afterStartedAt filter.
  • beforeFinishedAt/afterFinishedAt filter.

• Task error field is set to null by default.

• Task canceledBy field is set to null by default.

• Task details sub-fields are set to null when Meilsearch can't know the information depending on the task status. @Kerollmops please check the changes within the spec and suggests precision/correction, if any.

• Add Tasks Canceled telemetry event

  • user_agent
  • filtered_by_uid
  • filtered_by_index_uid
  • filtered_by_status
  • filtered_by_type
  • filtered_by_canceled_by
  • filtered_by_before_enqueued_at
  • filtered_by_after_enqueued_at
  • filtered_by_before_started_at
  • filtered_by_after_started_at
  • filtered_by_before_finished_at
  • filtered_by_after_finished_at

Breaking Changes ⚠️

• 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

Out Of Scope

Explain in clear way subjects that are out of scope and shouldn't be discussed by the reviewers

---

Attention To Reviewers

The delete tasks PR will be based on the cancel-tasks-feature branch because changes are mostly the same.

---

Misc

• Update OpenAPI specification file
• Update telemetry datapoints

[gmourier]

@alallema

• I created a new sub-section in #### 11. Filtering task resources and split into two sections ##### 11.1. Filtering task to get and ##### 11.2. Filtering task to cancel but maybe all this information should be mixed in the #### 11. Filtering task resources -> I agreed; it's a bit redundant. 👍
• Auto-batching task cancelation should be added -> It could be added as a specific section for the POST - /tasks/cancel endpoint section or either be added in the auto-batching specification.

[gmourier]

Thanks @alallema, here is a first draft review.

I think the specification can be extremely simplified if we explain all the filters listing and behaviors in one single place; since all tasks endpoints can use them there is no need to repeat that information for every endpoints.

• I couldn't mark it as a suggestion but in some places, it is mentioned that dumpCreation is a global task. e.g. Summarized task Object for 202 Accepted. It would be worthwhile to make a section listing the types of tasks that are global and therefore have a null indexUid.

• Don't forget to update the api-keys specification since we are adding a new action tasks.cancel

[Kerollmops]

According to our discussion on Slack, we must go with originalFilter because, technically, it is one filter expression and for consistency with the search route.

[Kerollmops]

Looks good to me 😃