diff --git a/docs/reference-docs/api/workflow/upgrade-workflow.md b/docs/reference-docs/api/workflow/upgrade-workflow.md new file mode 100644 index 00000000..eec0d835 --- /dev/null +++ b/docs/reference-docs/api/workflow/upgrade-workflow.md @@ -0,0 +1,80 @@ +--- +sidebar_position: 15 +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Upgrade Workflow + +This api is used to upgrade running workflow to a newer/older version. +All the tasks that present earlier in the new definition will be marked as skipped. +taksOutput is the map contains output of the tasks that are going to be skipped. +workflowInput is the map if user want to set the input to the workflow that is being upgraded. +The support for this api is in beta. + +## Input Payload + +| Attribute | Description | +|---------------|------------------------------------------------------------------------------------------------------------------------------| +| workflowId | The unique identifier of the workflow to be upgraded. | +| name | Name of the workflow to pick the definition from. | +| version | Version of the workflow to pick the definition from. | +| taskOutput | Map of Key and Value for the tasks that are going to be skipped. key is the task reference name and value is the task output | +| workflowInput | Map of Key and Value given as the input to the new workflow execution | + +## API Endpoint +``` +POST /workflow/{workflowId}/upgrade +``` + +## Examples + + +## Client SDK Methods + + + + +```java +void upgradeRunningWorkflow(String workflowId, UpgradeWorkflowRequest upgradeWorkflowRequest) +``` + + + + +```go +``` + + + + +```python +``` + + + + +```csharp +``` + + + + +```javascript +``` + + + + +```typescript +``` + + + + +```clojure +``` + + + \ No newline at end of file