io.katharsis.resource.annotations

Annotation Type JsonApiIncludeByDefault

@Documented
 @Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface JsonApiIncludeByDefault

Indicates additional resources that should be included by default with every primary resource. The field can be added to every relation defined by JsonApiToOne or JsonApiToMany. Otherwise, ResourceException will be thrown at the initialization phrase.

Included resources added using this annotation are not analyzed for nested inclusion, that is only first level of inclusion is provided.