Skip to content

Document the Delete Task API - #12954

Open
cwperks wants to merge 2 commits into
opensearch-project:mainfrom
cwperks:delete-task
Open

Document the Delete Task API#12954
cwperks wants to merge 2 commits into
opensearch-project:mainfrom
cwperks:delete-task

Conversation

@cwperks

@cwperks cwperks commented Aug 21, 2026

Copy link
Copy Markdown
Member

Description

Adds API documentation for the Delete Task API introduced by opensearch-project/OpenSearch#21727.

The new page explains how to delete stored completed task results, distinguishes deletion from task cancellation, documents common response codes, and describes the leaf-first deletion requirement for parent and child task results. It also places the new page in the Tasks APIs navigation.

Issues Resolved

Documents opensearch-project/OpenSearch#21727.

Version

3.8

Frontend features

Not applicable.

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.

Signed-off-by: Craig Perkins <craig5008@gmail.com>
@github-actions github-actions Bot added the In progress Issue/PR: The issue or PR is in progress. label Aug 21, 2026
@github-actions

Copy link
Copy Markdown

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference).

@cwperks
cwperks marked this pull request as ready for review August 21, 2026 03:18
@github-actions github-actions Bot added Tech review PR: Tech review in progress and removed In progress Issue/PR: The issue or PR is in progress. labels Aug 21, 2026
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

@kolchfa-aws kolchfa-aws left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks, @cwperks! Doc review complete and changes applied. Version changed to 3.9. Please let me know when you add the API spec for this so I can regenerate the appropriate sections. Thanks!

@kolchfa-aws kolchfa-aws added Doc review PR: Doc review in progress Awaiting response and removed Tech review PR: Tech review in progress labels Aug 24, 2026
@cwperks

cwperks commented Aug 25, 2026

Copy link
Copy Markdown
Member Author

Thanks, @cwperks! Doc review complete and changes applied. Version changed to 3.9. Please let me know when you add the API spec for this so I can regenerate the appropriate sections. Thanks!

I will create this later today.

@cwperks

cwperks commented Aug 26, 2026

Copy link
Copy Markdown
Member Author

The API specification PR is now open: https://github.com/opensearch-project/opensearch-api-specification/pull/1215\n\nIt adds the OpenSearch 3.9 delete-task operation, acknowledged response schema, and a focused Tasks story that passed locally against OpenSearch 3.9.0-SNAPSHOT.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Awaiting response Doc review PR: Doc review in progress

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants