Skip to content

5.0 updates to System.Text.Json docs - #21108

Merged
tdykstra merged 52 commits into
dotnet:masterfrom
tdykstra:stj5a
Nov 5, 2020
Merged

5.0 updates to System.Text.Json docs#21108
tdykstra merged 52 commits into
dotnet:masterfrom
tdykstra:stj5a

Conversation

@tdykstra

@tdykstratdykstra commented Oct 14, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor

Fixes#21313

Document new features in 5.0 for System.Text.Json.

There are other outstanding issues for the System.Text.Json docs, this one addresses only the new features for 5.0.

Internal review URL - how-to doc
Internal review URL - migration doc
Internal review URL - custom converters doc

@dotnet-botdotnet-bot added this to the October 2020 milestone Oct 14, 2020
@adegeo

adegeo commented Oct 16, 2020

Copy link
Copy Markdown
Contributor

Close/reopen to see if snippets system can download the latest .net rc or not...

@adegeoadegeo closed this Oct 16, 2020
@adegeoadegeo reopened this Oct 16, 2020
@adegeoadegeo closed this Oct 16, 2020
@adegeoadegeo reopened this Oct 16, 2020
@tdykstratdykstra changed the title WIP: Test zone pivots for versionsWIP: 5.0 updates to System.Text.Json docsOct 19, 2020
gewarren
gewarren reviewed Oct 21, 2020
View reviewed changes

@gewarrengewarren left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I know it's a WIP, but was reading through anyway.

Comment threaddocs/standard/serialization/system-text-json-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-how-to.md Outdated
@tdykstra
tdykstra requested a review from a team as a code ownerOctober 27, 2020 18:54
@tdykstra
tdykstra removed the request for review from a teamOctober 27, 2020 19:19
layomia
layomia reviewed Oct 28, 2020
View reviewed changes
Comment threaddocs/standard/serialization/system-text-json-converters-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-converters-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-converters-how-to.md Outdated
Comment thread...ndard/serialization/snippets/system-text-json-how-to-5-0/csharp/CustomConverterHandleNull.cs
Comment thread...ndard/serialization/snippets/system-text-json-how-to-5-0/csharp/CustomConverterHandleNull.cs Outdated
layomia
layomia reviewed Oct 28, 2020
View reviewed changes
Comment threaddocs/standard/serialization/system-text-json-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-how-to.md
Comment threaddocs/standard/serialization/system-text-json-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-how-to.md Outdated
layomia
layomia reviewed Oct 29, 2020
View reviewed changes
Comment threaddocs/standard/serialization/snippets/system-text-json-how-to-5-0/csharp/Fields.cs
Comment threaddocs/standard/serialization/system-text-json-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-migrate-from-newtonsoft-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-migrate-from-newtonsoft-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-migrate-from-newtonsoft-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-migrate-from-newtonsoft-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-migrate-from-newtonsoft-how-to.md Outdated
jozkee
jozkee reviewed Oct 29, 2020
View reviewed changes
Comment threaddocs/standard/serialization/system-text-json-migrate-from-newtonsoft-how-to.md Outdated
layomia
layomia reviewed Nov 4, 2020
View reviewed changes

@layomialayomia left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks great. LGTM after these comments are addressed.

Comment threaddocs/standard/serialization/system-text-json-converters-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-converters-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-converters-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-converters-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-converters-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-migrate-from-newtonsoft-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-migrate-from-newtonsoft-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-migrate-from-newtonsoft-how-to.md Outdated
Comment threaddocs/standard/serialization/system-text-json-migrate-from-newtonsoft-how-to.md Outdated
* During deserialization, the JSON contains a null value for a non-nullable value type.

In the same scenario, <xref:System.Text.Json> does throw an exception. (The corresponding nullhandling setting is <xref:System.Text.Json.JsonSerializerOptions.IgnoreNullValues?displayProperty=nameWithType>.)
In the same scenario, <xref:System.Text.Json> does throw an exception. (For the corresponding null-handling setting in `System.Text.Json`, see [Conditionally ignore a property](#conditionally-ignore-a-property).)

@layomialayomiaNov 4, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should this link to notes about per-property ignoring or the global setting i.e. DefaultIgnoreCondition.WhenWritingDefault?

@tdykstratdykstraNov 5, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I believe the equivalent here is JsonSerializerOptions.IgnoreNullValues, which I removed from the main how-to doc per your comment:

I'm not sure we should advertise this. IgnoreNullValues is obsolete starting in .NET 6.0, and we couldn't think of when it makes sense to ignore a null value received when deserializing.

Comment threaddocs/standard/serialization/system-text-json-migrate-from-newtonsoft-how-to.md Outdated
jozkee
jozkee reviewed Nov 4, 2020
View reviewed changes
Comment threaddocs/standard/serialization/system-text-json-how-to.md Outdated
@tdykstra
tdykstra merged commit 9d5e88e into dotnet:masterNov 5, 2020
@tdykstra
tdykstra deleted the stj5a branch November 5, 2020 23:31
@tdykstratdykstra mentioned this pull request Nov 5, 2020
Merged
@tdykstratdykstra mentioned this pull request Jan 7, 2021
Closed
@tdykstratdykstra mentioned this pull request Jan 26, 2021
Closed
@lipchevlipchev mentioned this pull request Sep 12, 2021
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jozkeejozkeejozkee left review comments
@gewarrengewarrengewarren approved these changes
@ahsonkhanahsonkhanAwaiting requested review from ahsonkhan
@adegeoadegeoAwaiting requested review from adegeo
+2 more reviewers
@steveharterstevehartersteveharter left review comments
@layomialayomialayomia left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

October 2020

Development

Successfully merging this pull request may close these issues.

Document new features in 5.0 for System.Text.Json

7 participants

@tdykstra@adegeo@steveharter@layomia@jozkee@gewarren@dotnet-bot