io.swagger.oas.annotations.media

Annotation Type ExampleObject

@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Inherited
public @interface ExampleObject

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	externalValue a URL to point to an external document to be used as an example.
String	name a unique name to identify this particular example
String	summary a brief summary of the purpose or context of the example
String	value a string representation of the example.

Element Detail

name

public abstract String name

a unique name to identify this particular example

Default:

""

summary

public abstract String summary

a brief summary of the purpose or context of the example

Default:

""

value

public abstract String value

a string representation of the example. If the media type associated with the example allows parsing into an object, it may be converted from a string

Default:

""

externalValue

public abstract String externalValue

a URL to point to an external document to be used as an example. This is mutually exclusive with the value property

Default:

""