org.graylog2.rest.documentation.annotations

Annotation Type ApiParam

@Target(value={PARAMETER,METHOD,FIELD})
@Retention(value=RUNTIME)
public @interface ApiParam

Author:

Lennart Koopmann

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	title Name of this parameter

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description A longer description
boolean	required Is this parameter required?

Element Detail

title

public abstract String title

Name of this parameter

description

public abstract String description

A longer description

Default:

""

required

public abstract boolean required

Is this parameter required?

Default:

false