Package io.wcm.caravan.hal.docs.annotations

Annotation Type LinkRelationDoc

@Target(FIELD)
@Retention(RUNTIME)
public @interface LinkRelationDoc

Marks a string constant as link relation documentation.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
ResourceRefDoc[]	embedded	Embedded resources that may be returned in the response of this relation.
String	jsonSchema	Reference/URL to JSON schema.
LinkRelationRefDoc[]	links	Link relations that may be returned in the response of this relation.
Class<?>	model	Reference to domain object model which should be used to detect the corresponding JSON schema.

Element Detail

jsonSchema

String jsonSchema

Reference/URL to JSON schema.

Default:

""

model

Class<?> model

Reference to domain object model which should be used to detect the corresponding JSON schema.

Default:

void.class

embedded

ResourceRefDoc[] embedded

Embedded resources that may be returned in the response of this relation.

Default:

{}

links

LinkRelationRefDoc[] links

Link relations that may be returned in the response of this relation.

Default:

{}