Introduce @JsonIgnoreUnknownKeys annotation #2874
Merged
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
fzhinkin
reviewed
Dec 5, 2024
formats/json/commonMain/src/kotlinx/serialization/json/JsonAnnotations.kt
Outdated
Show resolved
Hide resolved
fzhinkin
reviewed
Dec 5, 2024
shanshin
approved these changes
Dec 6, 2024
| * should be ignored instead of throwing [SerializationException]. | ||
| * | ||
| * With this annotation, it is possible to allow unknown properties for annotated classes, while | ||
| * general [Json.decodeFromString] would still reject them for everything else. |
There was a problem hiding this comment.
Perhaps I'm exaggerating, but won't such a description give the user the impression that this annotation only works with decodeFromString, but not with decodeFromJsonElement or decodeFromStream?
There was a problem hiding this comment.
Not sure about that. Maybe rephrase as general decoding methods, such as [Json.decodeFromString] and others?
fzhinkin
approved these changes
Dec 6, 2024
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.
for more fine-grained control over JsonBuilder.ignoreUnknownKeys setting.
Fixes #1420
Also improve error message and path handling when 'Unknown key' exception is thrown
Fixes #2869
Fixes #2637