net.ozwolf.raml.annotations

Annotation Type RamlSchema

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface RamlSchema

RAML Schema Annotation

An annotation that can be placed on a response or request class that either references a classpath schema file or a raw example value.

If found on a class, it will override any attempt to auto-generate a schema document.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value A schema value.

Element Detail

value

public abstract String value

A schema value.

Can either reference a classpath schema file or contain the raw schema document.

The contents of this can either be in standard schema format for the content type or in a RAML-acceptable structure.

Returns:

the schema value