[DOC] Introducing Sync Execution for Workflow Provisioning: Adding wait_for_completion_timeout

[junweid62]

What do you want to do?

• Request a change to existing documentation
• Add new documentation
• Report a technical problem with the documentation
• Other

Tell us about your request.

Currently, the Workflow API provisions workflows asynchronously. The API responds immediately with a 200 OK, requiring clients to poll the Workflow Status API to monitor the provisioning status. While this approach enables front-end progress visualization, it adds complexity for automation tools that must implement polling mechanisms.
Certain use cases, such as Machine Learning Commons Remote Model Deployment, benefit from synchronous provisioning, allowing the API to return only when the workflow is completed.

Now, we are adding the wait_for_completion_timeout parameter to allow synchronized calls in three endpoints:

1. POST /_plugins/_flow_framework/workflow?provision=true
2. POST /_plugins/_flow_framework/workflow/<workflow_id>/_provision
3. PUT /_plugins/_flow_framework/workflow/<workflow_id>?reprovision=true

Version: 2.19 and after

What other resources are available?
PR: opensearch-project/flow-framework#990
Issue: opensearch-project/flow-framework#967