Noop as a hook to remove a resource from cached data

Noop as a hook for defining how deserialized resource objects are cached, e.g. in memory

Noop as a hook for defining how to handle cache after updating a resource

Create (add) a relationship for to-many relation, sends a POST request.

See: http://jsonapi.org/format/#crud-updating-to-many-relationships

Adds a relation using a payload with a resource identifier object:

{
  "data": [
    { "type": "comments", "id": "12" }
  ]
}

Create a new resource, sends a POST request, updates resource instance with persisted data, and updates cache with persisted resource

Deletes a relationship for to-many relation, sends a DELETE request.

See: http://jsonapi.org/format/#crud-updating-to-many-relationships

Remove using a payload with the resource identifier object:

For to-many:

{
  "data": [
    { "type": "comments", "id": "1" }
  ]
}

Delete an existing resource, sends a DELETE request

Fetches data using Fetch API or XMLHttpRequest

Sets Authorization header if accessible in the authorizationCredential property

Adds params and headers or Fetch request.

• The HTTP Header is set for Content-Type: application/vnd.api+json
• Sets Authorization header if accessible in the authorizationCredential property

Hook to customize the URL, e.g. if your API is behind a proxy and you need to swap a portion of the domain to make a request on the same domain.

Find resource(s) using an id or a using a query {id: '', query: {}}

Find a resource by id, optionally pass a query object, e.g. w/ filter param(s)

Uses a url like: /photos/1

Find resources using an optional query object, e.g. w/ pagination params

Find resources by relationship or use a specificed (optional) service to find relation

A Url like: /photos/1/relationships/photographer is a required param

service.findRelated('photographer', '/api/v1/photos/1/relationships/photographer');

Or, with option to find related resource using a different service

service.findRelated({relation: 'photographer', type: 'people'}, url);

Patch a relationship, either adds or removes everyting, sends a PATCH request.

See: http://jsonapi.org/format/#crud-updating-to-one-relationships

For to-one relation:

• Remove (delete) with payload: { "data": null }
• Create/Update with payload:

  {
    "data": { "type": "comments", "id": "1" }
  }
  

For to-many relation:

• Remove (delete) all with payload: { "data": [] }
• Replace all with payload:

  {
    "data": [
      { "type": "comments", "id": "1" },
      { "type": "comments", "id": "2" }
    ]
  }
  

Patch an existing resource, sends a PATCH request.