docs: JSON:API refactor #472
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
2 tasks
askvortsov1
reviewed
Mar 27, 2024
| ## Serializers | ||
| ### Inclusion & Linkage | ||
|
|
||
| You can mark a relationship as includable through the `includable` method. This means that the relationship can be included in the API response. You can also use the `withLinkage` and `withoutLinkage` methods to determine whether the relationship ID(s) should be included in the API response (`ToMany` relationships are not linked by default contrary to `ToOne` relationships). |
There was a problem hiding this comment.
When would you have non-includable relationships?
There was a problem hiding this comment.
When you only need a relationship to be writable perhaps. Though not a common use case, it remains valid.
There was a problem hiding this comment.
Might be worth adding a short tip about this
Co-authored-by: Alexander Skvortsov <[email protected]>
askvortsov1
approved these changes
Apr 5, 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.
Documents breaking changes for the upgrade guide and links to the new documentation for API resources.
It adds links to tags extension from 1.x and the one from 2.x as an example for before and after.