In some scenarios, JSON-API does not define how an implementation should behave. Elide also may not implement all optional features of the JSON-API specification. The following sections clarify Elide’s behavior with respect to undefined or optional aspects of JSON-API.
Elide generally follows the JSON-API recommendations for URL design.
There are a few caveats given that Elide allows developers control over how entities are exposed:
/articles/1/author/address. Instead, the author must be fully qualified by ID:
Filters are covered in this section.
Elide supports three mechanisms by which a newly created entity is assigned an ID:
Elide looks for the JPA
GeneratedValue annotation to disambiguate whether or not
the data store generates an ID for a given data model. If the client also generated
an ID during the object creation request, the data store ID overrides the client value.
When using the patch extension, Elide always returns object entity bodies (containing newly assigned IDs) in the order in which they were created. The client can use this order to map the object created to its ID.
ID fields must be
Serializable objects. Elide does not require IDs to be UUIDs (a divergence from JSON-API).