Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating actor serialization documentation #1371

Merged
merged 6 commits into from
Oct 18, 2024

Conversation

WhitWaldo
Copy link
Contributor

Description

Updated the actor serialization documentation to reflect the differences between the JSON serialization and the Data Contract serialization approaches used in the Dapr.Actors SDK, how they relate to the different actor client types and some examples of how to properly use each of them.

Issue reference

We strive to have all PR being opened based on an issue, where the problem or feature have been discussed prior to implementation.

This addresses a comment left at #1073 (comment) and occasionally seen in Discord though doesn't have an open issue that I see.

Checklist

Please make sure you've completed the relevant tasks for this PR, out of the following list:

  • [N/A] Code compiles correctly
  • [N/A] Created/updated tests
  • Extended the documentation

…rialization between either type and added a brief section to detail the use of System.Text.Json for weakly-typed Dapr actor clients and to point to official documentation on it

Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
…verrides

Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
…r a custom JSON serializer and extension method to facilitate custom enum values during (de)serialization.

Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
@WhitWaldo WhitWaldo added documentation Improvements or additions to documentation area/actor labels Oct 17, 2024
@WhitWaldo WhitWaldo added this to the v1.15 milestone Oct 17, 2024
@WhitWaldo WhitWaldo self-assigned this Oct 17, 2024
@WhitWaldo WhitWaldo requested review from a team as code owners October 17, 2024 21:41
@WhitWaldo WhitWaldo merged commit 1e14887 into dapr:master Oct 18, 2024
10 checks passed
@WhitWaldo WhitWaldo deleted the actor-serialization-docs branch October 18, 2024 07:56
humandigital-michiel pushed a commit to humandigital-agency/dapr-dotnet-sdk that referenced this pull request Oct 23, 2024
* Changed headers, updated introduction to reflect the difference in serialization between either type and added a brief section to detail the use of System.Text.Json for weakly-typed Dapr actor clients and to point to official documentation on it

---------

Signed-off-by: Whit Waldo <whit.waldo@innovian.net>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/actor documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants