com.wordnik.swagger.annotations

Annotation Type ApiParam

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

Represents a single parameter in an Api Operation. A parameter is an input to the operation

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	access specify an optional access value for filtering in a Filter implementation.
String	allowableValues Description of values this endpoint accepts
boolean	allowMultiple specifies whether or not the parameter can have multiple values provided
String	defaultValue Default value - if e.g.
String	name Name of the parameter
boolean	required specifies if the parameter is required or not
String	value Description of the parameter

Element Detail

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

specifies if the parameter is required or not

Default:

false

access

public abstract String access

specify an optional access value for filtering in a Filter implementation. This allows you to hide certain parameters if a user doesn't have access to them

Default:

""

allowMultiple

public abstract boolean allowMultiple

specifies whether or not the parameter can have multiple values provided

Default:

false