diff --git a/daprdocs/content/en/concepts/building-blocks-concept.md b/daprdocs/content/en/concepts/building-blocks-concept.md index ca3d7b955ff..a66ba848a24 100644 --- a/daprdocs/content/en/concepts/building-blocks-concept.md +++ b/daprdocs/content/en/concepts/building-blocks-concept.md @@ -22,7 +22,7 @@ Dapr provides the following building blocks: |----------------|----------|-------------| | [**Service-to-service invocation**]({{< ref "service-invocation-overview.md" >}}) | `/v1.0/invoke` | Service invocation enables applications to communicate with each other through well-known endpoints in the form of http or gRPC messages. Dapr provides an endpoint that acts as a combination of a reverse proxy with built-in service discovery, while leveraging built-in distributed tracing and error handling. | [**Publish and subscribe**]({{< ref "pubsub-overview.md" >}}) | `/v1.0/publish` `/v1.0/subscribe`| Pub/Sub is a loosely coupled messaging pattern where senders (or publishers) publish messages to a topic, to which subscribers subscribe. Dapr supports the pub/sub pattern between applications. -| [**Workflows**]({{< ref "workflow-overview.md" >}}) | `/v1.0-beta1/workflow` | The Workflow API enables you to define long running, persistent processes or data flows that span multiple microservices using Dapr workflows or workflow components. The Workflow API can be combined with other Dapr API building blocks. For example, a workflow can call another service with service invocation or retrieve secrets, providing flexibility and portability. +| [**Workflows**]({{< ref "workflow-overview.md" >}}) | `/v1.0/workflow` | The Workflow API enables you to define long running, persistent processes or data flows that span multiple microservices using Dapr workflows or workflow components. The Workflow API can be combined with other Dapr API building blocks. For example, a workflow can call another service with service invocation or retrieve secrets, providing flexibility and portability. | [**State management**]({{< ref "state-management-overview.md" >}}) | `/v1.0/state` | Application state is anything an application wants to preserve beyond a single session. Dapr provides a key/value-based state and query APIs with pluggable state stores for persistence. | [**Bindings**]({{< ref "bindings-overview.md" >}}) | `/v1.0/bindings` | A binding provides a bi-directional connection to an external cloud/on-premise service or system. Dapr allows you to invoke the external service through the Dapr binding API, and it allows your application to be triggered by events sent by the connected service. | [**Actors**]({{< ref "actors-overview.md" >}}) | `/v1.0/actors` | An actor is an isolated, independent unit of compute and state with single-threaded execution. Dapr provides an actor implementation based on the virtual actor pattern which provides a single-threaded programming model and where actors are garbage collected when not in use. diff --git a/daprdocs/content/en/developing-applications/building-blocks/workflow/howto-author-workflow.md b/daprdocs/content/en/developing-applications/building-blocks/workflow/howto-author-workflow.md index 2b37739d15a..a12478250a0 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/workflow/howto-author-workflow.md +++ b/daprdocs/content/en/developing-applications/building-blocks/workflow/howto-author-workflow.md @@ -821,7 +821,7 @@ func main() { ctx := context.Background() // Start workflow test - respStart, err := daprClient.StartWorkflowBeta1(ctx, &client.StartWorkflowRequest{ + respStart, err := daprClient.StartWorkflow(ctx, &client.StartWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, WorkflowName: "TestWorkflow", @@ -835,7 +835,7 @@ func main() { fmt.Printf("workflow started with id: %v\n", respStart.InstanceID) // Pause workflow test - err = daprClient.PauseWorkflowBeta1(ctx, &client.PauseWorkflowRequest{ + err = daprClient.PauseWorkflow(ctx, &client.PauseWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) @@ -844,7 +844,7 @@ func main() { log.Fatalf("failed to pause workflow: %v", err) } - respGet, err := daprClient.GetWorkflowBeta1(ctx, &client.GetWorkflowRequest{ + respGet, err := daprClient.GetWorkflow(ctx, &client.GetWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) @@ -859,7 +859,7 @@ func main() { fmt.Printf("workflow paused\n") // Resume workflow test - err = daprClient.ResumeWorkflowBeta1(ctx, &client.ResumeWorkflowRequest{ + err = daprClient.ResumeWorkflow(ctx, &client.ResumeWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) @@ -868,7 +868,7 @@ func main() { log.Fatalf("failed to resume workflow: %v", err) } - respGet, err = daprClient.GetWorkflowBeta1(ctx, &client.GetWorkflowRequest{ + respGet, err = daprClient.GetWorkflow(ctx, &client.GetWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) @@ -886,7 +886,7 @@ func main() { // Raise Event Test - err = daprClient.RaiseEventWorkflowBeta1(ctx, &client.RaiseEventWorkflowRequest{ + err = daprClient.RaiseEventWorkflow(ctx, &client.RaiseEventWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, EventName: "testEvent", @@ -904,7 +904,7 @@ func main() { fmt.Printf("stage: %d\n", stage) - respGet, err = daprClient.GetWorkflowBeta1(ctx, &client.GetWorkflowRequest{ + respGet, err = daprClient.GetWorkflow(ctx, &client.GetWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) @@ -915,7 +915,7 @@ func main() { fmt.Printf("workflow status: %v\n", respGet.RuntimeStatus) // Purge workflow test - err = daprClient.PurgeWorkflowBeta1(ctx, &client.PurgeWorkflowRequest{ + err = daprClient.PurgeWorkflow(ctx, &client.PurgeWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) @@ -923,7 +923,7 @@ func main() { log.Fatalf("failed to purge workflow: %v", err) } - respGet, err = daprClient.GetWorkflowBeta1(ctx, &client.GetWorkflowRequest{ + respGet, err = daprClient.GetWorkflow(ctx, &client.GetWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) @@ -936,7 +936,7 @@ func main() { fmt.Printf("stage: %d\n", stage) // Terminate workflow test - respStart, err = daprClient.StartWorkflowBeta1(ctx, &client.StartWorkflowRequest{ + respStart, err = daprClient.StartWorkflow(ctx, &client.StartWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, WorkflowName: "TestWorkflow", @@ -950,7 +950,7 @@ func main() { fmt.Printf("workflow started with id: %s\n", respStart.InstanceID) - err = daprClient.TerminateWorkflowBeta1(ctx, &client.TerminateWorkflowRequest{ + err = daprClient.TerminateWorkflow(ctx, &client.TerminateWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) @@ -958,7 +958,7 @@ func main() { log.Fatalf("failed to terminate workflow: %v", err) } - respGet, err = daprClient.GetWorkflowBeta1(ctx, &client.GetWorkflowRequest{ + respGet, err = daprClient.GetWorkflow(ctx, &client.GetWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) @@ -971,12 +971,12 @@ func main() { fmt.Println("workflow terminated") - err = daprClient.PurgeWorkflowBeta1(ctx, &client.PurgeWorkflowRequest{ + err = daprClient.PurgeWorkflow(ctx, &client.PurgeWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) - respGet, err = daprClient.GetWorkflowBeta1(ctx, &client.GetWorkflowRequest{ + respGet, err = daprClient.GetWorkflow(ctx, &client.GetWorkflowRequest{ InstanceID: "a7a4168d-3a1c-41da-8a4f-e7f6d9c718d9", WorkflowComponent: workflowComponent, }) diff --git a/daprdocs/content/en/developing-applications/building-blocks/workflow/howto-manage-workflow.md b/daprdocs/content/en/developing-applications/building-blocks/workflow/howto-manage-workflow.md index 162ec4a4102..8aeeab0b0ff 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/workflow/howto-manage-workflow.md +++ b/daprdocs/content/en/developing-applications/building-blocks/workflow/howto-manage-workflow.md @@ -324,7 +324,7 @@ Manage your workflow using HTTP calls. The example below plugs in the properties To start your workflow with an ID `12345678`, run: ```http -POST http://localhost:3500/v1.0-beta1/workflows/dapr/OrderProcessingWorkflow/start?instanceID=12345678 +POST http://localhost:3500/v1.0/workflows/dapr/OrderProcessingWorkflow/start?instanceID=12345678 ``` Note that workflow instance IDs can only contain alphanumeric characters, underscores, and dashes. @@ -334,7 +334,7 @@ Note that workflow instance IDs can only contain alphanumeric characters, unders To terminate your workflow with an ID `12345678`, run: ```http -POST http://localhost:3500/v1.0-beta1/workflows/dapr/12345678/terminate +POST http://localhost:3500/v1.0/workflows/dapr/12345678/terminate ``` ### Raise an event @@ -342,7 +342,7 @@ POST http://localhost:3500/v1.0-beta1/workflows/dapr/12345678/terminate 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-beta1/workflows///raiseEvent/ +POST http://localhost:3500/v1.0/workflows///raiseEvent/ ``` > An `eventName` can be any function. @@ -352,13 +352,13 @@ POST http://localhost:3500/v1.0-beta1/workflows//}}). diff --git a/daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-patterns.md b/daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-patterns.md index ba3ab432f1b..24db5b49252 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-patterns.md +++ b/daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-patterns.md @@ -647,7 +647,7 @@ The Dapr workflow HTTP API supports the asynchronous request-reply pattern out-o The following `curl` commands illustrate how the workflow APIs support this pattern. ```bash -curl -X POST http://localhost:3500/v1.0-beta1/workflows/dapr/OrderProcessingWorkflow/start?instanceID=12345678 -d '{"Name":"Paperclips","Quantity":1,"TotalCost":9.95}' +curl -X POST http://localhost:3500/v1.0/workflows/dapr/OrderProcessingWorkflow/start?instanceID=12345678 -d '{"Name":"Paperclips","Quantity":1,"TotalCost":9.95}' ``` The previous command will result in the following response JSON: @@ -659,7 +659,7 @@ The previous command will result in the following response JSON: The HTTP client can then construct the status query URL using the workflow instance ID and poll it repeatedly until it sees the "COMPLETE", "FAILURE", or "TERMINATED" status in the payload. ```bash -curl http://localhost:3500/v1.0-beta1/workflows/dapr/12345678 +curl http://localhost:3500/v1.0/workflows/dapr/12345678 ``` The following is an example of what an in-progress workflow status might look like. @@ -1365,7 +1365,7 @@ func raiseEvent() { if err != nil { log.Fatalf("failed to initialize the client") } - err = daprClient.RaiseEventWorkflowBeta1(context.Background(), &client.RaiseEventWorkflowRequest{ + err = daprClient.RaiseEventWorkflow(context.Background(), &client.RaiseEventWorkflowRequest{ InstanceID: "instance_id", WorkflowComponent: "dapr", EventName: "approval_received", diff --git a/daprdocs/content/en/operations/configuration/api-allowlist.md b/daprdocs/content/en/operations/configuration/api-allowlist.md index b0a02d9bf1f..dffb8db3910 100644 --- a/daprdocs/content/en/operations/configuration/api-allowlist.md +++ b/daprdocs/content/en/operations/configuration/api-allowlist.md @@ -127,7 +127,7 @@ See this list of values corresponding to the different Dapr APIs: | [Configuration]({{< ref configuration_api.md >}}) | `configuration` (`v1.0` and `v1.0-alpha1`) | `configuration` (`v1` and `v1alpha1`) | | [Distributed Lock]({{< ref distributed_lock_api.md >}}) | `lock` (`v1.0-alpha1`)
`unlock` (`v1.0-alpha1`) | `lock` (`v1alpha1`)
`unlock` (`v1alpha1`) | | [Cryptography]({{< ref cryptography_api.md >}}) | `crypto` (`v1.0-alpha1`) | `crypto` (`v1alpha1`) | -| [Workflow]({{< ref workflow_api.md >}}) | `workflows` (`v1.0-alpha1`) |`workflows` (`v1alpha1`) | +| [Workflow]({{< ref workflow_api.md >}}) | `workflows` (`v1.0`) |`workflows` (`v1`) | | [Health]({{< ref health_api.md >}}) | `healthz` (`v1.0`) | n/a | | Shutdown | `shutdown` (`v1.0`) | `shutdown` (`v1`) | diff --git a/daprdocs/content/en/reference/api/workflow_api.md b/daprdocs/content/en/reference/api/workflow_api.md index 91a19d86407..9236fbfce08 100644 --- a/daprdocs/content/en/reference/api/workflow_api.md +++ b/daprdocs/content/en/reference/api/workflow_api.md @@ -17,7 +17,7 @@ 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. ``` -POST http://localhost:3500/v1.0-beta1/workflows///start[?instanceID=] +POST http://localhost:3500/v1.0/workflows///start[?instanceID=] ``` Note that workflow instance IDs can only contain alphanumeric characters, underscores, and dashes. @@ -57,7 +57,7 @@ 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 +POST http://localhost:3500/v1.0/workflows///terminate ``` {{% alert title="Note" color="primary" %}} @@ -91,7 +91,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-beta1/workflows///raiseEvent/ +POST http://localhost:3500/v1.0/workflows///raiseEvent/ ``` {{% alert title="Note" color="primary" %}} @@ -124,7 +124,7 @@ None. Pause a running workflow instance. ``` -POST http://localhost:3500/v1.0-beta1/workflows///pause +POST http://localhost:3500/v1.0/workflows///pause ``` ### URL parameters @@ -151,7 +151,7 @@ None. Resume a paused workflow instance. ``` -POST http://localhost:3500/v1.0-beta1/workflows///resume +POST http://localhost:3500/v1.0/workflows///resume ``` ### URL parameters @@ -178,7 +178,7 @@ None. Purge the workflow state from your state store with the workflow's instance ID. ``` -POST http://localhost:3500/v1.0-beta1/workflows///purge +POST http://localhost:3500/v1.0/workflows///purge ``` {{% alert title="Note" color="primary" %}} @@ -209,7 +209,7 @@ None. Get information about a given workflow instance. ``` -GET http://localhost:3500/v1.0-beta1/workflows// +GET http://localhost:3500/v1.0/workflows// ``` ### URL parameters