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

Annotation Type ResourceRefDoc

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

Describes an embedded resource in a HAL response.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	value	Embedded resource name.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	description	Optional description for describing the embedded resource.
String	jsonSchema	Reference/URL to JSON schema.
Class<?>	model	Reference to domain object model which should be used to detect the corresponding JSON schema.

Element Detail

value

String value

Embedded resource name.

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

description

String description

Optional description for describing the embedded resource.

Default:

""