From 3f1be97f5c79c1f645cf69f6ce67de98546e7f04 Mon Sep 17 00:00:00 2001 From: Shubham Sharma Date: Tue, 6 Jun 2023 14:27:27 +0530 Subject: [PATCH 1/2] Add fixes Signed-off-by: Shubham Sharma --- .../content/en/reference/api/workflow_api.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/daprdocs/content/en/reference/api/workflow_api.md b/daprdocs/content/en/reference/api/workflow_api.md index e784e52e1..e417eed63 100644 --- a/daprdocs/content/en/reference/api/workflow_api.md +++ b/daprdocs/content/en/reference/api/workflow_api.md @@ -12,8 +12,8 @@ Dapr provides users with the ability to interact with workflows and comes with a Start a workflow instance with the given name and optionally, an instance ID. -```http -POST http://localhost:3500/v1.0-alpha1/workflows///start[?instanceId=] +``` +POST http://localhost:3500/v1.0-alpha1/workflows///start[?instanceID=] ``` Note that workflow instance IDs can only contain alphanumeric characters, underscores, and dashes. @@ -24,7 +24,7 @@ Parameter | Description --------- | ----------- `workflowComponentName` | Use `dapr` for Dapr Workflows `workflowName` | Identify the workflow type -`instanceId` | (Optional) Unique value created for each run of a specific workflow +`instanceID` | (Optional) Unique value created for each run of a specific workflow ### Request content @@ -52,7 +52,7 @@ The API call will provide a response similar to this: Terminate a running workflow instance with the given name and instance ID. -```http +``` POST http://localhost:3500/v1.0-alpha1/workflows///terminate ``` @@ -79,7 +79,7 @@ This API does not return any content. For workflow components that support subscribing to external events, such as the Dapr Workflow engine, you can use the following "raise event" API to deliver a named event to a specific workflow instance. -```http +```` POST http://localhost:3500/v1.0-alpha1/workflows///raiseEvent/ ``` @@ -112,7 +112,7 @@ None. Pause a running workflow instance. -```http +``` POST http://localhost:3500/v1.0-alpha1/workflows///pause ``` @@ -139,7 +139,7 @@ None. Resume a paused workflow instance. -```http +``` POST http://localhost:3500/v1.0-alpha1/workflows///resume ``` @@ -166,7 +166,7 @@ None. Purge the workflow state from your state store with the workflow's instance ID. -```http +```` POST http://localhost:3500/v1.0-alpha1/workflows///purge ``` @@ -193,7 +193,7 @@ None. Get information about a given workflow instance. -```http +```` GET http://localhost:3500/v1.0-alpha1/workflows// ``` From 981444ff02d6ba31a865f240e685de9766ee21c3 Mon Sep 17 00:00:00 2001 From: Shubham Sharma Date: Tue, 6 Jun 2023 14:30:06 +0530 Subject: [PATCH 2/2] Revert extra tick Signed-off-by: Shubham Sharma --- daprdocs/content/en/reference/api/workflow_api.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/daprdocs/content/en/reference/api/workflow_api.md b/daprdocs/content/en/reference/api/workflow_api.md index e417eed63..80814852e 100644 --- a/daprdocs/content/en/reference/api/workflow_api.md +++ b/daprdocs/content/en/reference/api/workflow_api.md @@ -79,7 +79,7 @@ This API does not return any content. For workflow components that support subscribing to external events, such as the Dapr Workflow engine, you can use the following "raise event" API to deliver a named event to a specific workflow instance. -```` +``` POST http://localhost:3500/v1.0-alpha1/workflows///raiseEvent/ ``` @@ -166,7 +166,7 @@ None. Purge the workflow state from your state store with the workflow's instance ID. -```` +``` POST http://localhost:3500/v1.0-alpha1/workflows///purge ``` @@ -193,7 +193,7 @@ None. Get information about a given workflow instance. -```` +``` GET http://localhost:3500/v1.0-alpha1/workflows// ```