Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add delete_tasks method #394

Conversation

brunoocasali
Copy link
Member

@brunoocasali brunoocasali commented Nov 14, 2022

  • A new endpoint: DELETE /tasks
  • Guarantee all the filters available in the GET /tasks minus 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

@brunoocasali brunoocasali added the enhancement New feature or request label Nov 14, 2022
@brunoocasali brunoocasali changed the base branch from bump-meilisearch-v0.30.0-add-cancel-tasks to bump-meilisearch-v0.30.0-add-swap-indexes November 14, 2022 22:24
Copy link
Member

@mdubus mdubus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM ✨ 🦕

@curquiza
Copy link
Member

👆 I just don't see all the changes you gave in the PR description like "Add deletedTasks in field details from Task type when performing taskDeletion" -> I guess you have nothing to change in Ruby but it's confusing for a reviewer 😇

Same I don't see any filter addition in this PR

@brunoocasali
Copy link
Member Author

👆 I just don't see all the changes you gave in the PR description like "Add deletedTasks in field details from Task type when performing taskDeletion" -> I guess you have nothing to change in Ruby but it's confusing for a reviewer 😇

Same I don't see any filter addition in this PR

You're correct @curquiza it was a bad CTRL+C/CTRL+V. But in the filters case, ALLOWED_CANCELATION_PARAMS is responsible for allowing all of those filters to work in this PR.

Base automatically changed from bump-meilisearch-v0.30.0-add-swap-indexes to bump-meilisearch-v0.30.0 November 17, 2022 20:13
@brunoocasali brunoocasali force-pushed the bump-meilisearch-v0.30.0-add-delete-tasks branch from e59f737 to 6030ebe Compare November 17, 2022 20:52
@brunoocasali brunoocasali force-pushed the bump-meilisearch-v0.30.0-add-delete-tasks branch from 6030ebe to 6f920dc Compare November 17, 2022 21:04
@brunoocasali brunoocasali merged commit 2dd1681 into bump-meilisearch-v0.30.0 Nov 17, 2022
@brunoocasali brunoocasali deleted the bump-meilisearch-v0.30.0-add-delete-tasks branch November 17, 2022 21:04
meili-bors bot added a commit that referenced this pull request Nov 28, 2022
401: Update version for the next release (v0.21.0) r=brunoocasali a=brunoocasali

This version makes this package compatible with Meilisearch v0.30.0 🎉
Check out the changelog of [Meilisearch v0.30.0](https://github.com/meilisearch/meilisearch/releases/tag/v0.30.0) for more information on the changes.

## 🚀 Enhancements

- Add `MeilisearchClient#cancel_tasks` (#392) `@brunoocasali` 
- Add `MeilisearchClient#swap_indexes` (#393) `@brunoocasali` 
- Add `MeilisearchClient#delete_tasks` (#394) `@brunoocasali` 
- Add support to finite pagination by using `page` and `hits_per_page` like `index.search('', { page: 1, hits_per_page: 10 })`
- Add filters for tasks resources (#391) `@brunoocasali` 
  - `uids` filter parameter for `MeilisearchClient#get_tasks({ uids: [1, 2, 3] })`
  - `canceled_by` filter parameter for `MeilisearchClient#get_tasks({ canceled_by: [99, 100]})`
  - `before_enqueued_at` and `after_enqueued_at` filter parameter for `MeilisearchClient#get_tasks({ before_enqueued_at: DateTime.new(2022), after_enqueued_at: '2022-01-20' })`
  - `before_finished_at` and `after_finished_at` filter parameter for `MeilisearchClient#get_tasks({ before_finished_at: DateTime.new(2022), after_finished_at: '2022-01-20' })`
  - `before_started_at` and `after_started_at` filter parameter for `MeilisearchClient#get_tasks({ before_started_at: DateTime.new(2022), after_started_at: '2022-01-20' })`

## ⚠️  Breaking Changes

- Update filters for tasks resources (#391) `@brunoocasali` 
  - `index_uid` query parameter is renamed `index_uids` when querying `MeilisearchClient#get_tasks`
  - `type` query parameter is renamed `types` when querying `MeilisearchClient#get_tasks`
  - `status` query parameter is renamed `statuses` when querying `MeilisearchClient#get_tasks`

## 💅 Misc

* Fix broken CI after rubocop upgrade (#381) `@jonatanrdsantos`
* Add new code-samples for matching_strategy (#384) `@thicolares`
* Improve indexes names in tests (#385) `@thicolares`

Thanks again to `@brunoocasali,` `@dibashthapa,` `@jonatanrdsantos,` and `@thicolares!` 🎉


Co-authored-by: Bruno Casali <brunoocasali@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants