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.

Sign up for GitHub

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

Jump to bottom

Clarify cancel task API reference #2818

Open
guimachiavelli opened this issue May 6, 2024 · 0 comments · May be fixed by #3080
Open

Clarify cancel task API reference #2818

guimachiavelli opened this issue May 6, 2024 · 0 comments · May be fixed by #3080
Labels
fix/improvement good first issue Issues that are easy or quick to fix

Comments

@guimachiavelli
Copy link
Member

In the docs we state (emphasis mine):

Cancel any number of enqueued or processing tasks based on their uid, status, type, indexUid, or the date at which they were enqueued, processed, or completed.

The highlighted bit is incorrect. Users can only cancel enqueued or processing tasks, so it is not possible to cancel a task by its completed date. Additionally, we need to clarify that "processed" in this case means the startedAt date.

Thanks for the report, @CaroFG
@guimachiavelli guimachiavelli added fix/improvement good first issue Issues that are easy or quick to fix labels May 6, 2024
RecreationalMath added a commit to RecreationalMath/documentation that referenced this issue Dec 12, 2024
@RecreationalMath
Updated cancel task API reference
906fdd9 
Fixes meilisearch#2818 

Currently cancel task API reference incorrectly mentions that even completed tasks can be cancelled. Updated the documentation to rectify that. Additionally added clarifications for which dates can be used for cancelling tasks.

Things to check:

1. Does the suggested change clearly convey the dates that can be used for task cancellation criteria?
2. Is there any ambiguity left here for the first time reader that needs addressal?
@RecreationalMath RecreationalMath linked a pull request Dec 12, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
fix/improvement good first issue Issues that are easy or quick to fix
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Updated cancel tasks API reference RecreationalMath/documentation
1 participant
@guimachiavelli