[DOC] Update embedded-records-mixin.js #6958
Conversation
| @@ -19,6 +19,8 @@ import { warn } from '@ember/debug'; | |||
|
|
|||
| Note that embedded records will serialize with the serializer for their model instead of the serializer in which they are defined. | |||
|
|
|||
| Note also that this mixin does not work with JSONAPISerializer because the JSON API spec does not describe how to format embedded resources. | |||
There was a problem hiding this comment.
General question I do not know the answer to: what versions of the JSON:API spec does ember-data adhere to? I would like to qualify this caveat with that answer.
There was a problem hiding this comment.
edit: tagging @NullVoxPopuli so he knows I screen-shotted his discord message :P
There was a problem hiding this comment.
Thanks! Upon further reflection I think ember-data should describe its compatibility with JSON:API somewhere for transparency. It seems better suited to top-level documentation or some kind of introduction. So we can leave it out of this PR.
There was a problem hiding this comment.
Upon further reflection I think ember-data should describe its compatibility with JSON:API somewhere for transparency. It seems better suited to top-level documentation or some kind of introduction.
We do in the serializer documentation overview
|
@runspired any objections to merging? Also, I think we can add the changelog:doc label. |
ghost
mentioned this pull request
hjdivad
changed the title
|
rebased which should get CI green |
|
@hjdivad looks like a few ember data tests are still failing- any insight there? |
Embedded Records Mixin is not compatible with JSONAPISerializer
|
Okay, I went ahead and force-pushed a change with a fresh branch. I'm not sure why but simply rebasing this branch triggered a few merge conflicts with unrelated files. Any theories on why that might've been happening would be helpful for me in the future :) |
|
<3 Thanks @allthesignals ! |
Those were failing external partner tests. In particular travis-web: Acceptance | repo/trigger build: triggering a custom build via the dropdown |
Adding documentation on the embedded records mixin explaining that it does not work with JSONAPISerializer. This should be noted more prominently rather than in a passive warning message (which might get buried under a sea of deprecation warnings in the test suite).