com.holonplatform.jaxrs.swagger.annotations

Annotation Type ApiPropertySetModel

@Target(value={PARAMETER,TYPE,TYPE_USE})
 @Retention(value=RUNTIME)
 @Documented
public @interface ApiPropertySetModel

Annotation which can be used in conjuction with PropertySetRef to declare a Swagger Model name to create using the PropertySet definition and to append to Swagger model definitions.

Since:

5.0.0

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value Provide the model name.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description Optional model description.
String	reference Specifies a reference to the corresponding type definition, overrides any other metadata specified.

Element Detail

value

public abstract String value

Provide the model name.

Returns:

The Swagger Model name

description

public abstract String description

Optional model description.

Returns:

Model description

Default:

""

reference

public abstract String reference

Specifies a reference to the corresponding type definition, overrides any other metadata specified.

Returns:

Model reference

Default:

""