docs: Added documentation on new jsonKey model alias feature #405
+41
−0
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
8 tasks
There was a problem hiding this comment.
Pull request overview
Adds documentation for the new jsonKey model field attribute to describe JSON key aliasing behavior and how to use it in model YAML.
Changes:
- Documented
jsonKeyusage with YAML + Dart examples and common use cases. - Added an info callout clarifying interaction with database column naming.
- Added
jsonKeyto the model keywords reference table.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
marcelomendoncasoares
approved these changes
Jan 29, 2026
Collaborator
marcelomendoncasoares
left a comment
marcelomendoncasoares
left a comment
There was a problem hiding this comment.
Thanks for the quick PR with the docs, @FXschwartz! Nicely done!! 🚀
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Cover usage over PR - serverpod/serverpod#4614
@marcelomendoncasoares Docs submitted for the jsonKey model alias usage! Let me know what kind of changes you'd like made.