Update JsonSerializerOptions.xml #10330
Open
+4
−2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Refine IncludeFields remarks to highlight that only public fields are serialized and that private fields are not.
dotnet-policy-service
bot
added
the
community-contribution
|
Tagging subscribers to this area: @dotnet/area-system-text-json |
|
Learn Build status updates of commit 238352d: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
Comment on lines
+714
to
+715
| <remarks>Only includes public fields during serialization and deserialization. Private fields are not included, even if IncludeFields is set to <see langword="true" />. | ||
| If you need to include private fields, you would typically use properties with appropriate accessors or consider using attributes like [JsonInclude] on those fields. |
There was a problem hiding this comment.
Suggested change
| <remarks>Only includes public fields during serialization and deserialization. Private fields are not included, even if IncludeFields is set to <see langword="true" />. | |
| If you need to include private fields, you would typically use properties with appropriate accessors or consider using attributes like [JsonInclude] on those fields. | |
| <remarks>This flag only enables serialization for public fields, as is the case for properties. | |
| Private members need to be opted into individually using the <see cref="T:System.Text.Json.Serialization.JsonIncludeAttribute" /> attribute. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Refine IncludeFields remarks to highlight that only public fields are serialized and that private fields are not.
Summary
Revised the documentation for JsonSerializerOptions.IncludeFields property clarify that setting the property
to true will only result in 'public' fields being serialized, private fields are not serialized.