Skip to content

Conversation

@hhunter-ms
Copy link
Contributor

@hhunter-ms hhunter-ms commented Feb 28, 2025

Description

  • Update Python examples in "How to Author"
  • Update Python examples in "How to Manage"
  • Update quickstart examples

Extra item:

  • Update Python example in Conversation quickstart from HTTP to SDK

Issue reference

PR will close: #4410

@hhunter-ms hhunter-ms self-assigned this Feb 28, 2025
@hhunter-ms hhunter-ms requested review from a team as code owners February 28, 2025 21:38
@hhunter-ms hhunter-ms marked this pull request as draft February 28, 2025 21:38
@github-actions
Copy link

github-actions bot commented Mar 6, 2025

Stale PR, paging all reviewers

@github-actions github-actions bot added the stale label Mar 6, 2025
@hhunter-ms hhunter-ms removed the stale label Mar 17, 2025
@hhunter-ms hhunter-ms marked this pull request as ready for review March 17, 2025 17:04
@msfussell
Copy link
Member

This is correct for Python, however the manage Workflows article to Schedule a new workflow are wrong for .NET and for Go still and need updating in the same way that you updated the Python ones from start to scheduleNewWorkflow

So this .NET sample should be changed (best to ask @WhitWaldo )

// Start the workflow. This returns back a "StartWorkflowResponse" which contains the instance ID for the particular workflow instance.
StartWorkflowResponse startResponse = await daprClient.StartWorkflowAsync(orderId, workflowComponent, workflowName, 

Look at the examples here https://github.com/dapr/dotnet-sdk/tree/master/examples/Workflow, but actually they all need to change since they have Workflow Component that is not correct. Hopefully Whit can help.

And the Go Sample should be replaced by the example here https://github.com/dapr/go-sdk/blob/main/examples/workflow/main.go (without the test cases) entirely

In both cases, need to also change the names of the APIs in that section from Start to ScheduleNewWorkflow (.NET does not have a list of APIs like the other language have)

Note that the Javascript one is still start and will be changed by @WhitWaldo over the next month.

@hhunter-ms
Copy link
Contributor Author

This is correct for Python, however the manage Workflows article to Schedule a new workflow are wrong for .NET and for Go still and need updating in the same way that you updated the Python ones from start to scheduleNewWorkflow

So this .NET sample should be changed (best to ask @WhitWaldo )

// Start the workflow. This returns back a "StartWorkflowResponse" which contains the instance ID for the particular workflow instance.
StartWorkflowResponse startResponse = await daprClient.StartWorkflowAsync(orderId, workflowComponent, workflowName, 

Look at the examples here https://github.com/dapr/dotnet-sdk/tree/master/examples/Workflow, but actually they all need to change since they have Workflow Component that is not correct. Hopefully Whit can help.

And the Go Sample should be replaced by the example here https://github.com/dapr/go-sdk/blob/main/examples/workflow/main.go (without the test cases) entirely

In both cases, need to also change the names of the APIs in that section from Start to ScheduleNewWorkflow (.NET does not have a list of APIs like the other language have)

Note that the Javascript one is still start and will be changed by @WhitWaldo over the next month.

Created new docs issues from this comment - might be best to focus in a separate PR so we can finally close out this Python issue!

@WhitWaldo
Copy link
Contributor

@msfussell I'm going to hold off on updating the docs for JS for right now as they're pretty inconsistent with the other languages. Once I get those changes merged, I'll revisit this.

Copy link
Member

@msfussell msfussell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@hhunter-ms hhunter-ms merged commit f612ab7 into dapr:v1.15 Mar 19, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The Python example for Conversation Quickstart should be the SDK, not HTTP Python SDK docs are outdated

4 participants