com.wordnik.swagger.annotations

Annotation Type ApiModelProperty

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

An ApiModelProperty desecribes a property inside a model class. The annotations can apply to a method, a property, etc., depending on how the model scanner is configured and used.

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 If the values that can be set are restricted, they can be set here.
String	dataType The dataType.
boolean	hidden Allows a model property to be marked as hidden in the swagger model definition
String	notes long description of the property
int	position allows explicitly ordering the property in the model.
boolean	required Whether or not the property is required, defaults to false.
String	value Provide a human readable synopsis of this property

Element Detail

value

public abstract String value

Provide a human readable synopsis of this property

Default:

""

allowableValues

public abstract String allowableValues

If the values that can be set are restricted, they can be set here. In the form of a comma separated list registered, active, closed.

Returns:

the allowable values

Default:

""

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:

""

notes

public abstract String notes

long description of the property

Default:

""

dataType

public abstract String dataType

The dataType. See the documentation for the supported datatypes. If the data type is a custom object, set it's name, or nothing. In case of an enum use 'string' and allowableValues for the enum constants.

Default:

""

required

public abstract boolean required

Whether or not the property is required, defaults to false.

Returns:

true if required, false otherwise

Default:

false

position

public abstract int position

allows explicitly ordering the property in the model. Since reflection has no guarantee on ordering, you should specify property order to keep models consistent across different VM implementations and versions.

Default:

0

hidden

public abstract boolean hidden

Allows a model property to be marked as hidden in the swagger model definition

Default:

false