Generalize comment on monitoring reindex tasks #5170
+5
−5
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
|
Following you can find the validation changes against the target branch for the APIs. No changes detected. You can validate these APIs yourself by using the |
leemthompo
reviewed
Aug 21, 2025
| @@ -68,7 +68,7 @@ import { Destination, Source } from './types' | |||
| * | |||
| * It's recommended to reindex on indices with a green status. Reindexing can fail when a node shuts down or crashes. | |||
| * * When requested with `wait_for_completion=true` (default), the request fails if the node shuts down. | |||
| * * When requested with `wait_for_completion=false`, a task id is returned, which can be used via the task management API to monitor, debug, or cancel the task. The task may disappear or fail if the node shuts down. | |||
| * * When requested with `wait_for_completion=false`, a task id is returned, which can be used via the task management API to monitor the task. The task may disappear or fail if the node shuts down. | |||
There was a problem hiding this comment.
Suggested change
| * * When requested with `wait_for_completion=false`, a task id is returned, which can be used via the task management API to monitor the task. The task may disappear or fail if the node shuts down. | |
| * * When requested with `wait_for_completion=false`, a task id is returned, for use with the task management APIs. The task may disappear or fail if the node shuts down. |
There was a problem hiding this comment.
totally optional idea, just for consideration if wanted to be even more generic :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In serverless, only GET is supported for the task management API, so users can't cancel a task.
I think this is the simplest fix, as monitoring the reindex task is probably the most relevant part for troubleshooting. I can also make the description more granular if that's a better approach