com.linkedin.restli.restspec
Annotation Type RestSpecAnnotation

@Retention(value=RUNTIME)
@Target(value={METHOD,ANNOTATION_TYPE})
public @interface RestSpecAnnotation

Meta-annotation which turns annotation used in Rest.li resource classes into restspec custom annotation. The member values of such annotations are passed through to the generated .restspec.json files. This meta-annotation can be used to annotate annotation as well as member methods. The method-level restspec annotation always overrides annotation-level counterpart.

Optional Element Summary

boolean	exclude
java.lang.String	name
boolean	skipDefault

name

public abstract java.lang.String name

Returns:

subject name of the annotated in .restspec.json

Default:

""

exclude

public abstract boolean exclude

Returns:

exclude the annotated

Default:

false

skipDefault

public abstract boolean skipDefault

Returns:

true to skip outputting the member to .restspec.json when its value equals to the default value

Default:

true