com.github.jrcodeza

Annotation Type OpenApiExample

@Target(value={TYPE,FIELD,PARAMETER,METHOD})
 @Retention(value=RUNTIME)
public @interface OpenApiExample

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description
String	key
String	name
String	value If not filled in then key has to be filled in.

Element Detail

name

public abstract String name

Default:

""

description

public abstract String description

Default:

""

value

public abstract String value

If not filled in then key has to be filled in. CustomExampleResolver will be invoked with key value as parameter.

Returns:

Default:

""

key

public abstract String key

Default:

""