Document the Delete Task API - #12954
Conversation
Signed-off-by: Craig Perkins <craig5008@gmail.com>
|
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). |
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
kolchfa-aws
left a comment
There was a problem hiding this comment.
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. |
|
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. |
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