feat: make the serialization of nil relationships configurable#403
Open
pwcsquared wants to merge 1 commit intobeam-community:mainfrom
Open
feat: make the serialization of nil relationships configurable#403pwcsquared wants to merge 1 commit intobeam-community:mainfrom
pwcsquared wants to merge 1 commit intobeam-community:mainfrom
Conversation
pwcsquared
changed the title
Enable serializing loaded nil associations serializable with the :serialize_nil_relationships config option
pwcsquared
force-pushed
the
serialize-nil-rels-configurable
branch
from
003c4f2 to
b76ec06
Compare
mattpolzin
approved these changes
Mar 11, 2026
Member
mattpolzin
left a comment
mattpolzin
left a comment
There was a problem hiding this comment.
Looks great to me. I'll leave the PR open for a day or two to give time for other feedback.
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
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.
Currently, singular relationships that are loaded on a resource but are
nilin value are excluded from serialization by this library. While the JSON:API spec doesn't specifically say that all possible relationships must be serialized, it does mention that relationship resource linkages for empty to-one relationships should be represented asnull.This PR enables serializing these empty relationships as null through the configuration option
:serialize_nil_relationships, which defaults tofalseto preserve existing functionality.