io.swagger.annotations

Annotation Type ExampleProperty

@Target(value=ANNOTATION_TYPE)
@Retention(value=RUNTIME)
public @interface ExampleProperty

A mediaType/value property within a Swagger example

Since:

1.5.4

See Also:

Example

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value The value of the example.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	mediaType The name of the property.

Element Detail

value

public abstract String value

The value of the example.

Returns:

the value of the example

mediaType

public abstract String mediaType

The name of the property.

Returns:

the name of the property

Default:

"default"