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
Open

Clarify cancel task API reference #2818

guimachiavelli opened this issue May 6, 2024 · 0 comments
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
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

No branches or pull requests
1 participant
@guimachiavelli