From 649e91f95323603a77771e8093a5738f57522206 Mon Sep 17 00:00:00 2001 From: Josh van Leeuwen Date: Fri, 9 Feb 2024 16:48:06 +0000 Subject: [PATCH] Workflow terminate/purge: remove `non_recursive` query option (#4008) * Updates workflow terminate/purge `non_recursive` query to `recursive` Updates from PR https://github.com/dapr/dapr/pull/7498 Signed-off-by: joshvanl * Removes recursive workflow delete strategy from API completely Signed-off-by: joshvanl --------- Signed-off-by: joshvanl Co-authored-by: Mark Fussell --- .../workflow/workflow-features-concepts.md | 2 +- daprdocs/content/en/reference/api/workflow_api.md | 12 +++++------- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-features-concepts.md b/daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-features-concepts.md index 2fab89e640c..a31fff10e20 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-features-concepts.md +++ b/daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-features-concepts.md @@ -97,7 +97,7 @@ Child workflows have many benefits: The return value of a child workflow is its output. If a child workflow fails with an exception, then that exception is surfaced to the parent workflow, just like it is when an activity task fails with an exception. Child workflows also support automatic retry policies. -Terminating a parent workflow terminates all of the child workflows created by the workflow instance. You can disable this by setting the query parameter `non_recursive` to `true` while sending the terminate request to the parent workflow. See [the terminate workflow api]({{< ref "workflow_api.md#terminate-workflow-request" >}}) for more information. +Terminating a parent workflow terminates all of the child workflows created by the workflow instance. See [the terminate workflow api]({{< ref "workflow_api.md#terminate-workflow-request" >}}) for more information. ## Durable timers diff --git a/daprdocs/content/en/reference/api/workflow_api.md b/daprdocs/content/en/reference/api/workflow_api.md index 1dc80ef5413..fc77137725a 100644 --- a/daprdocs/content/en/reference/api/workflow_api.md +++ b/daprdocs/content/en/reference/api/workflow_api.md @@ -57,12 +57,12 @@ The API call will provide a response similar to this: Terminate a running workflow instance with the given name and instance ID. ``` -POST http://localhost:3500/v1.0-beta1/workflows///terminate[?non_recursive=false] +POST http://localhost:3500/v1.0-beta1/workflows///terminate ``` {{% alert title="Note" color="primary" %}} - Terminating a workflow terminates all of the child workflows created by the workflow instance. You can disable this by setting the query parameter `non_recursive` to `true`. - + Terminating a workflow terminates all of the child workflows created by the workflow instance. + Terminating a workflow has no effect on any in-flight activity executions that were started by the terminated instance. {{% /alert %}} @@ -73,7 +73,6 @@ Parameter | Description --------- | ----------- `workflowComponentName` | Use `dapr` for Dapr Workflows `instanceId` | Unique value created for each run of a specific workflow -`non_recursive` | (Optional) Boolean to determine if Dapr should not recursively terminate child workflows created by the workflow instance. Default value is `false`. ### HTTP response codes @@ -179,11 +178,11 @@ None. Purge the workflow state from your state store with the workflow's instance ID. ``` -POST http://localhost:3500/v1.0-beta1/workflows///purge[?non_recursive=false] +POST http://localhost:3500/v1.0-beta1/workflows///purge ``` {{% alert title="Note" color="primary" %}} - Purging a workflow purges all of the child workflows created by the workflow instance. You can disable this by setting the query parameter `non_recursive` to `true`. + Purging a workflow purges all of the child workflows created by the workflow instance. {{% /alert %}} @@ -193,7 +192,6 @@ Parameter | Description --------- | ----------- `workflowComponentName` | Use `dapr` for Dapr Workflows `instanceId` | Unique value created for each run of a specific workflow -`non_recursive` | (Optional) Boolean to determine if Dapr should not recursively purge child workflows created by the workflow instance. Default value is `false`. ### HTTP response codes