Skip to content

Commit

Permalink
upgrade docs
Browse files Browse the repository at this point in the history
  • Loading branch information
manan164 committed Sep 21, 2023
1 parent 8a29a38 commit 2105f2b
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions docs/reference-docs/api/workflow/upgrade-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem';

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.
taskOutput 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.

Expand All @@ -18,8 +18,8 @@ The support for this api is in beta.
| 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. |
| name | Name of the workflow to pick the definition for upgrade. |
| version | Version of the workflow to pick the definition for upgrade. |
| 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 |

Expand All @@ -30,6 +30,28 @@ POST /workflow/{workflowId}/upgrade

## Examples

Consider a workflow definition as per below,
<p align="center"><img src="/content/img/upgrade-workflow-old-definition.png" alt="Upgrade workflow old definition" width="90%" height="auto"></img></p>
and the new definition of the workflow is,
<p align="center"><img src="/content/img/upgrade-workflow-new-definition.png" alt="Upgrade workflow new definition" width="90%" height="auto"></img></p>

Now the workflow with version 1 is triggered and currently task_2 is completed but task_4 is in running state,
<p align="center"><img src="/content/img/upgrade-workflow-old-running.png" alt="Upgrade workflow old instance running" width="90%" height="auto"></img></p>

Now when we call upgrade api with following UpgradeWorkflowRequest,
```java
UpgradeWorkflowRequest upgradeWorkflowRequest = new UpgradeWorkflowRequest();
Map<String, Object> output = Map.of("updatedBy" , "upgrade");
upgradeWorkflowRequest.setTaskOutput(Map.of("simple_task3", output,"simple_task1",output));
upgradeWorkflowRequest.setWorkflowInput(Map.of("name", "orkes"));

upgradeWorkflowRequest.setVersion(2);
upgradeWorkflowRequest.setName(workflowName);
```
The workflow state will be changed as below,
<p align="center"><img src="/content/img/upgrade-workflow-new-running.png" alt="Upgrade workflow new instance running" width="90%" height="auto"></img></p>
Also the task that are skipped i.e. simple_task_1 and simple_task_3 will have output as per the map output above.
The workflow input will also get changed as per the workflowInput map.

## Client SDK Methods

Expand Down
Binary file added static/img/upgrade-workflow-new-definition.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/upgrade-workflow-new-running.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/upgrade-workflow-old-definition.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/upgrade-workflow-old-running.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2105f2b

Please sign in to comment.