Patching relationships should be possible via relationship URLs.

[colinhiggs]

The jsonapi spec allows for altering relationship information either by PATCHing a resource and including the relationship information (https://jsonapi.org/format/#crud-updating-resource-relationships) or by sending PATCH, POST and DELETE requests to relationship URLs (https://jsonapi.org/format/#crud-updating-relationships).

jsonapi-vuex currently only supports the former and there are good reasons one might want to choose the latter. For instance, when updating a resource with many related resources (such as an article with many comments) we might have fetched only a subset of those related resources (because the results are paged, for example). If we PATCH said article and include the comments relationship in the patch, we will send an incomplete list of comments and unintentionally cause the server to delete many other comments from the relationship.

To support the latter, I think a diff style function which generates a list of patching actions (some of which are actually POST or DELETE in HTTP terms) might be useful. Something like:

todo = generate_patch_todo(new_data, old_data)
// todo = 
// [
//    ['PATCH', '/articles/1', {article_attributes}],
//    ['POST', '/articles/1/rels/comments', [{comments, 5}]],
//    ['DELETE', '/articles/1/rels/comments', [{comments, 2}, {comments,3}]]
//]
for (let todo_item of todo) {
    dispatch(todo_item)
}

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[geoidesic]

The examples shown only deal with non-relational patching.

1. Could you include an example of how to PATCH related data?
2. Are there helper methods for setting up patches or does one manually have to write the JSON object?

[mrichar1]

There are now 3 methods to handle updates via relationship URLs:

• postRelated - add relationships.
• deleteRelated - remove relationships.
• patchRelated - replace relationships.