io.swagger.api.annotations

Annotation Type ApiParamExtended

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

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	defaultValue
String	value The parameter description.
String	xorn

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	allowMultiple Another way to allow multiple values for a "query" parameter.
ApiParamExtended.DataType	dataType The data type of the parameter
String	name The parameter name as it appears in the URL pattern.
ApiParamExtended.ParamType	paramType The type of the parameter (that is, the location of the parameter in the request).
boolean	required Defines if parameter is mandatory

Element Detail

value

public abstract String value

The parameter description.

Returns:

description as string

defaultValue

public abstract String defaultValue

xorn

public abstract String xorn

name

public abstract String name

The parameter name as it appears in the URL pattern.

Returns:

name

Default:

""

required

public abstract boolean required

Defines if parameter is mandatory

Returns:

boolean if parameter is required

Default:

false

allowMultiple

public abstract boolean allowMultiple

Another way to allow multiple values for a "query" parameter. If used, the query parameter may accept comma-separated values.

Returns:

true if multiple allowed

Default:

false

paramType

public abstract ApiParamExtended.ParamType paramType

The type of the parameter (that is, the location of the parameter in the request).

Returns:

parameter type (default is PATH)

Default:

io.swagger.api.annotations.ApiParamExtended.ParamType.PATH

dataType

public abstract ApiParamExtended.DataType dataType

The data type of the parameter

Returns:

the data type (default is STRING)

Default:

io.swagger.api.annotations.ApiParamExtended.DataType.STRING