Skip to content

Release 2.0.0 Milestone 2

Pre-release
Pre-release
Compare
Choose a tag to compare
@gsteinacker gsteinacker released this 03 May 08:00
· 41 commits to master since this release

Bugfixes

  • Issue 22: Duplicate curies are now removed from embedded objects, if they are specified in the embedding HalRepresentation.

Breaking Changes

  • The API to create Links instances has changed: the former Links.linkingTo(List), Links.linkingTo(Link, Link...) is now replaced by Links.linkingTo() which is returning a Links.Builder. The reason for this is that it is now possible to specify more easily, whether a Link should be rendered as a single link object, or an array of link objects. The Links.Builder has now methods for this like, for example, single(Link, Link...) or array(Link, Link...). Have a look at section 4.3 for more details about adding links to a HalRepresentation.
  • Because the Links.Builder is now able to create single link objects as well as arrays of link objects, the corresponding functionality to register link-relation types to be rendered as arrays has been removed from RelRegistry.
  • Issue 21: Similar to the links, it is now possible to specify whether or not embedded resources are embedded as single resource objects, or arrays of resources objects.
  • Renamed RelRegistry to Curies
  • Issue 20: HalRepresentation was previously annotated with @JsonInclude(NON_NULL). This was changed so that only _links and _embedded are now annotated this way. This might change the behaviour / structure of existing applications. You should now annotate classes extending HalRepresentation, or attributes of such classes appropriately.