WIP: Add partial resources #77
Closed
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
Adds a notion of partial resources which are an extension of the `PrimaryData` internal type. This allows for separate definitions of models that do not have `id` fields and are not expected to have included data. This is useful in cases where a server should generate the IDs for resources: https://jsonapi.org/format/1.0/#crud-creating-client-ids There may be a few edge cases where a user wants support included resources without an id in the primary data, or wants to only submit relationships with an ID, but this can be resolved separately. TODO: - Check sanity of this change - Document methods - More tests
johnchildren
commented
Oct 28, 2020
| match doc.data.as_ref() { | ||
| Some(primary_data) => match *primary_data { | ||
| PrimaryData::None => bail!("Document had no data"), | ||
| PrimaryData::Single(_) => unimplemented!(), |
There was a problem hiding this comment.
This needs an implementation - presumably you should be able to build a partial resource from a full resource, though not the other way around.
johnchildren
commented
Oct 28, 2020
| partial_jsonapi_model!(NewAuthor; "authors"; has many books); | ||
|
|
||
| #[derive(Debug, PartialEq, Serialize, Deserialize)] | ||
| struct NewBook { |
There was a problem hiding this comment.
Should include a test that this model generates relationships and doesn't just smuggle things past seralisation as an attribute.
|
I don't think I'm going to get a chance to finish this unfortunately, and I'm not convinced it is even the best approach. |
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.
Adds a notion of partial resources which are an extension of the
PrimaryDatainternal type. This allows for separate definitions ofmodels that do not have
idfields and are not expected to have includeddata.
This is useful in cases where a server should generate the IDs for
resources: https://jsonapi.org/format/1.0/#crud-creating-client-ids
There may be a few edge cases where a user wants support included resources
without an id in the primary data, or wants to only submit relationships
with an ID, but this can be resolved separately.
TODO:
Hi,
Have been thinking about how to resolve #74 and therefore implemented the suggestion of PartialResources to what I would understand them to be. I have added a test, but this change requires an extra macro for implementing a new
PartialJsonApiModeltrait, with the idea that users would invoke this macro for a separate struct, though I am unsure on the ergonomics of this.If there is any feedback on these changes I would appreciate it, otherwise I will try to fixup this PR over the course of the next few weeks with docs and tests.