opensearch-project / opensearch-project/flow-framework
[FEATURE] Deprovision resources if wait_for_completion_timeout is exceeded
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 62
- Forks
- 66
- Avg merge
- 3d 20h
- Merged PRs (30d)
- 20
Description
Is your feature request related to a problem?
As per current documentation, if wait_for_completion_timeout is exceeded for Provision API, execution continues asynchronously. As user of Provision API, I think it may be better to stop provisioning, and deprovision created resources, because timeout may indicate request should fail, which is more aligned with my expectation. Continuing execution asynchronously is actually same experience as calling Provision API without wait_for_completion_timeout.
What solution would you like?
Add one more param like fail_on_timeout:boolean. Default is false, which ensures backward compatibility. If value is specified as true, when wait_for_completion_timeout is exceeded, fail the request and deprovision the created resources.
What alternatives have you considered?
One alternative solution is to simply change existing behavior to fail the request and deprovision the created resources when timeout is exceeded, without adding fail_on_timeout param
Do you have any additional context?
N/A
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Provision API behavior described in the issue and trace how wait_for_completion_timeout is handled when execution continues asynchronously. Clarify whether fail_on_timeout should be opt-in and how created resources are deprovisioned on timeout. Done means the chosen behavior is implemented while preserving the default backward-compatible behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100