Add migration guidance for Newtonsoft.Json JsonObject Title property #48213
+86
−0
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.
This PR adds comprehensive documentation for migrating from Newtonsoft.Json's
JsonObject(Title = "title")
attribute to System.Text.Json.Problem
The
JsonObjectAttribute.Title
property in Newtonsoft.Json is used to set the title in JSON schema generation, but System.Text.Json has no direct equivalent. Users migrating from Newtonsoft.Json needed guidance on how to achieve the same functionality.Solution
Added migration guidance that explains:
JsonObjectAttribute.Title
JsonSchemaExporter
withTransformSchemaNode
Changes Made
Migration Guide Updates
JsonObjectAttribute
section inmigrate-from-newtonsoft.md
to includeTitle
property guidanceTransformSchemaNode
to set schema titleSchema Exporter Documentation
extract-schema.md
demonstrating how to set custom schema titlesJsonObjectTitleExample.cs
with working code that shows theTransformSchemaNode
patternExample Code
The solution demonstrates how to transform schema nodes to add title metadata:
This approach provides the same functionality as Newtonsoft.Json's
JsonObject(Title = "PersonTitle")
but uses System.Text.Json's modern schema generation capabilities.Fixes #45862.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.