Skip to content

Commit abff4fc

Browse files
netramalimkam
andauthored
Update README.md
Co-authored-by: Melissa Kam <3768460+mkam@users.noreply.github.com>
1 parent 1676b00 commit abff4fc

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -477,7 +477,7 @@ marshaling and unmarshaling non-null values for the inner type.
477477

478478
### Nullable Relationship
479479

480-
The `NullableRelationship` type is a generic type used to handle relationships in JSON API payloads that is not set, set to null or set to a valid relationship in the request. This type provides an API for sending and receiving significant `null` values for relationship values of any type.
480+
The `NullableRelationship` type is a generic type used to handle relationships in JSON API payloads that are either not set, set to null, or set to a valid relationship in the request. This type provides an API for sending and receiving significant `null` values for relationship values of any type. It should be used when there's a need to distinguish between explicitly setting the relationship to `null` versus not including the attribute in the request.
481481

482482
In the example below, a payload is presented for a fictitious API that makes use of significant `null` values. Once enabled, the `NullableComment` relationship can only be disabled by updating it to a `null` value.
483483

0 commit comments

Comments
 (0)