com.github.jasminb.jsonapi.annotations

Annotation Type Relationship

@Target(value=FIELD)
 @Retention(value=RUNTIME)
public @interface Relationship

Annotation used to configure relationship field in JSON API resources.

Author:

jbegic

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	path Resource path, used to generate self link.
String	relatedPath Resource path, used to generate related link.
RelType	relType
boolean	resolve
boolean	serialise

Element Detail

value

public abstract String value

resolve

public abstract boolean resolve

Default:

false

serialise

public abstract boolean serialise

Default:

true

relType

public abstract RelType relType

Default:

com.github.jasminb.jsonapi.RelType.SELF

path

public abstract String path

Resource path, used to generate self link.

Default:

""

relatedPath

public abstract String relatedPath

Resource path, used to generate related link.

Default:

""