Add note about allowing out of order metadata properties

dotnet / dotnet-api-docs

.NET API reference documentation (.NET 5+, .NET Core, .NET Framework)

https://docs.microsoft.com/dotnet/api/

Other

725 stars 1.56k forks source link

Add note about allowing out of order metadata properties #10587

Closed gewarren closed 1 week ago

gewarren commented 2 weeks ago

Contributes to dotnet/docs#42592.

dotnet-policy-service[bot] commented 2 weeks ago

Tagging subscribers to this area: @dotnet/area-system-text-json

learn-build-service-prod[bot] commented 2 weeks ago

Learn Build status updates of commit 8e7163b:

:white_check_mark: Validation status: passed

File	Status	Preview URL	Details
xml/System.Text.Json.Serialization/ReferenceHandler.xml	:white_check_mark:Succeeded	View

For more details, please refer to the build report.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

gewarren commented 1 week ago

Would it make sense to also include mention of this feature in the polymorphism document?

https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json/polymorphism?pivots=dotnet-8-0

Polymorphism is the primary motivator for introducing this feature (e.g. because you're reading data off an external API that happens to place the $type discriminator in the middle of an object.

Yes, I will add it there separately too.