Review API-Guidelines: inter-module reference

[cgendreau]

In order to comply with #47 , inter-module references are not enforced at insert/update time. A module pointing to another module should only keep the namespace/context and the id. e.g. agent/bf70a499-89ac-4b83-bc5a-c3e1ca12af51 .

All modules should include asynchronous inter-module reference validation and produce a report of unresolvable references.

[cgendreau]

Same thing for resource removal. When a resource is soft-deleted (#46), it should also be reported in the asynchronous inter-module reference validation.

[cgendreau]

This should fit in JSON API but there is no "official" way to point to an "external" API.

Option1. Keep the relationship section simple:

"relationships": {
    "dcCreator": {
      "data": { "type": "person", "id": "9" }
    }
  }

and use the meta section to declare types that are external and how to reach them.

"meta": {
  "external": [
    {"type":"person" 
     "href":"dinaapi.org/agent/person"},
    {"type":"organization" 
     "href":"dinaapi.org/agent/organization"}
   ]
}

That would imply modules would need to know (by configuration) how to reach the other modules even if they will not do it themselves (as per #57).

Option 2: The alternative would be to simply ignore it and rely on the system routing to find it. It would work but it might be not obvious for an external user why, for example, the person relationship can not be expended.

[cgendreau]

@falkogloeckler you agree with option 1 or 2? @jdobber ?

[falkogloeckler]

@falkogloeckler you agree with option 1 or 2?

Option 1. Thx!