com.wordnik.swagger.annotations
Annotation Type ApiParam

@Target(value=PARAMETER)
@Retention(value=RUNTIME)
public @interface ApiParam

Optional Element Summary

String	access
String	allowableValues Description of values this endpoint accepts
boolean	allowMultiple
String	defaultValue Default value - if e.g.
String	internalDescription
String	name Name of the parameter
boolean	required
String	value Description of the parameter

name

public abstract String name

Name of the parameter

Default:

""

value

public abstract String value

Description of the parameter

Default:

""

defaultValue

public abstract String defaultValue

Default value - if e.g. no JAX-RS @DefaultValue is given

Default:

""

allowableValues

public abstract String allowableValues

Description of values this endpoint accepts

Default:

""

required

public abstract boolean required

Default:

false

access

public abstract String access

Default:

""

internalDescription

public abstract String internalDescription

Default:

""

allowMultiple

public abstract boolean allowMultiple

Default:

false