[LA-36971] Document DELETE /v1/tasks/:id endpoint#56
Open
tejanium wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Jira
LA-36971 (sub-task of LA-36517)
What
Documents the new
DELETE /v1/tasks/:idendpoint (Tasks section), added in learnamp/learnamp#23768.Adds a Delete a Task entry with cURL + Ruby examples, the required
tasks:deletescope, and 204 / 404 responses — matching the existing Delete a User / Delete a Team docs.Why
Customers (Winc Academy, ArcticWolf — see LA-36517) need to delete tasks via the API. The docs note that this is a soft delete (lifecycle becomes
deleted, retrievable viafilters[lifecycle]=deleted) and that associated access is revoked, consistent with the UI.Anything Else
Pairs with the app PR learnamp/learnamp#23768 — merge/deploy docs once that ships.
Note
Low Risk
Documentation-only change in API reference; no runtime or security behavior is modified in this repo.
Overview
Adds a Delete a Task section to the Tasks API docs for
DELETE /v1/tasks/{taskId}, aligned with existing delete endpoints (e.g. Delete a User / Delete a Team).The new entry includes cURL and Ruby client examples, documents the
tasks:deletescope, and describes 204 No Content and 404 Not Found responses. It explains that deletion is a soft delete (lifecycledeleted, still listable viafilters[lifecycle]=deletedon View All Tasks), revokes access granted by the task, and may take a few minutes to process—matching UI behavior.Reviewed by Cursor Bugbot for commit 1318cb5. Bugbot is set up for automated code reviews on this repo. Configure here.