Add delete task API specification - #1215
Open
cwperks wants to merge 2 commits into
Open
Conversation
Signed-off-by: Craig Perkins <craig5008@gmail.com>
cwperks
requested review from
Tokesh,
VachaShah,
Xtansia,
aabeshov,
harshavamsi,
karenyrx,
lucy66hw,
sachetalva and
sean-
as code owners
August 26, 2026 03:13
Signed-off-by: Craig Perkins <craig5008@gmail.com>
1 task
Hailong-am
reviewed
Sep 1, 2026
| description: The ID of the stored completed task result to delete (`node_id:task_number`). | ||
| required: true | ||
| schema: | ||
| $ref: '../schemas/_common.yaml#/components/schemas/TaskId' |
Contributor
There was a problem hiding this comment.
nit: get using $ref: '../schemas/_common.yaml#/components/schemas/Id', checked definition for both, they are same.
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
3 participants
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.
Description
Adds the API specification for
DELETE /_tasks/{task_id}, introduced in OpenSearch 3.9 by opensearch-project/OpenSearch#21727.The API deletes a stored completed task result and returns an acknowledged response. This change also extends the existing Tasks test story to wait for the asynchronous task to complete before deleting its stored result.
Related documentation: opensearch-project/documentation-website#12954
Testing
npm run lint:specnpm run lintnpm run mergenpm run test:unit -- --runInBandnpm run test:spec -- --opensearch-url http://localhost:9200 --tests tests/default/_core/tasks.yaml --verboseagainst a locally built OpenSearch 3.9.0-SNAPSHOT clusterThe focused Tasks specification story passed, including validation of the delete response:
{ "acknowledged": true }