[Validation] Use [JsonPropertyName] for display name #63291
Conversation
This file contains hidden or 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
Use `[JsonPropertyName("{value}")]` for the display name, if `[Display(Name = "{value}")` is not specified, instead of the property's name.
Contributes to dotnet#63290.
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the validation generator to use JsonPropertyName attributes for display names when Display attributes are not present. This improves the user experience by providing more meaningful display names in validation error messages when JSON property names are specified.
- Modifies the type parser to check for JsonPropertyName attributes as a fallback when Display attributes are not present
- Updates the ISymbolExtensions to support extracting display names from JsonPropertyName attributes with both named arguments and constructor arguments
- Adds the JsonPropertyNameAttribute to the well-known types for proper attribute detection
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| ValidationsGenerator.TypesParser.cs | Updates display name resolution logic to use JsonPropertyName as fallback after Display attribute |
| ISymbolExtensions.cs | Enhances GetDisplayName method to handle JsonPropertyName attribute extraction with both named and constructor arguments |
| WellKnownTypeData.cs | Adds JsonPropertyNameAttribute to the well-known types enumeration and names array |
| ValidationsGenerator.ComplexType.cs | Adds test case with ComplexTypeWithJsonPropertyName class to verify the new functionality |
| ValidatableInfoResolver.g.verified.cs | Updates test snapshot to include expected generated code for the JsonPropertyName test case |
Add own method for getting `[JsonPropertyName]` instead of mingling with `[Display]`.
Give better names.
- Check for `[Display]` before any `[JsonPropertyName]`. - Add test case for records.
3 tasks
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.
[Validation] Use [JsonPropertyName] for display
Use
[JsonPropertyName("{value}")]for the display name.Description
Use
[JsonPropertyName("{value}")]for the display name if[Display(Name = "{value}")is not specified instead of the property's name.I didn't make any changes to use it for the name due to #62341 (comment).
Contributes to #63290.