com.wordnik.swagger.annotations

Annotation Type ApiModelProperty

@Target(value={METHOD,FIELD})
@Retention(value=RUNTIME)
@Inherited
public @interface ApiModelProperty

Adds and manipulates data of a model property.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	access Allows for filtering a property from the API documentation.
String	allowableValues Limits the acceptable values for this property.
String	dataType The data type of the parameter.
boolean	hidden Allows a model property to be hidden in the Swagger model definition.
String	notes Currently not in use.
int	position Allows explicitly ordering the property in the model.
boolean	required Specifies if the parameter is required or not.
String	value A brief description of this property.

Element Detail

value

public abstract String value

A brief description of this property.

Default:

""

allowableValues

public abstract String allowableValues

Limits the acceptable values for this property.

There are three ways to describe the allowable values:

1. To set a list of values, provide a comma-separated list surrounded by square brackets. For example: [first, second, third].
2. To set a range of values, start the value with "range", and surrounding by square brackets include the minimum and maximum values. For example: range[1, 5].
3. To set a minimum/maximum value, use the same format for range but use "infinity" or "-infinity" as the second value. For example, range[1, infinity] means the minimum allowable value of this parameter is 1.

Default:

""

access

public abstract String access

Allows for filtering a property from the API documentation.

See Also:

com.wordnik.swagger.core.filter.SwaggerSpecFilter

Default:

""

notes

public abstract String notes

Currently not in use.

Default:

""

dataType

public abstract String dataType

The data type of the parameter.

This can be the class name or a primitive. The value will override the data type as read from the class property.

Default:

""

required

public abstract boolean required

Specifies if the parameter is required or not.

Default:

false

position

public abstract int position

Allows explicitly ordering the property in the model.

Default:

0

hidden

public abstract boolean hidden

Allows a model property to be hidden in the Swagger model definition.

Default:

false