MicroProfile 7.0 · org.eclipse.microprofile.openapi.annotations.media.ExampleObject

Method Summary

Modifier and Type	Method and Description
public String	Returns: a description of this example description() Long description for the example.
public Extension[]	Returns: array of extensions extensions() List of extensions to be added to the `Example` model corresponding to the containing annotation.
public String	Returns: an external URL of the example externalValue() A URL to point to an external document to be used as an example.
public String	Returns: the name of this example name() A unique name to identify this particular example in a map.
public String	Returns: reference to an example ref() Reference value to an Example object.
public String	Returns: a summary of this example summary() A brief summary of the purpose or context of the example
public String	Returns: the value of the example value() A string representation of the example.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

description	back to summary
public String description() Long description for the example. CommonMark syntax MAY be used for rich text representation. Returns:String a description of this example

description

back to summary

public String description()

Long description for the example. CommonMark syntax MAY be used for rich text representation.

Returns:String: a description of this example

extensions back to summary

extensions	back to summary
public Extension[] extensions() List of extensions to be added to the `Example` model corresponding to the containing annotation. Returns:Extension[] array of extensions Since 3.1

public Extension[] extensions()

List of extensions to be added to the Example model corresponding to the containing annotation.

Returns:Extension[]: array of extensions
Since: 3.1

externalValue	back to summary
public String externalValue() A URL to point to an external document to be used as an example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. This is mutually exclusive with the value property. Returns:String an external URL of the example

externalValue

back to summary

public String externalValue()

A URL to point to an external document to be used as an example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents.

This is mutually exclusive with the value property.

Returns:String: an external URL of the example

name back to summary

name	back to summary
public String name() A unique name to identify this particular example in a map. The name is REQUIRED when the example is defined within `org.eclipse.microprofile.openapi.annotations.Components`. The name will be used as the key to add this example to the 'examples' map for reuse. Returns:String the name of this example

public String name()

A unique name to identify this particular example in a map.

The name is REQUIRED when the example is defined within org.eclipse.microprofile.openapi.annotations.Components. The name will be used as the key to add this example to the 'examples' map for reuse.

Returns:String: the name of this example

ref back to summary

ref	back to summary
public String ref() Reference value to an Example object. This property provides a reference to an object defined elsewhere. This property may be used with `description()` and `summary()` but is mutually exclusive with all other properties. If properties other than `description` and `summary` are defined in addition to the `ref` property then the result is undefined. Returns:String reference to an example

public String ref()

Reference value to an Example object.

This property provides a reference to an object defined elsewhere. This property may be used with description() and summary() but is mutually exclusive with all other properties. If properties other than description and summary are defined in addition to the ref property then the result is undefined.

Returns:String: reference to an example

summary	back to summary
public String summary() A brief summary of the purpose or context of the example Returns:String a summary of this example

summary

back to summary

public String summary()

A brief summary of the purpose or context of the example

Returns:String: a summary of this example

value	back to summary
public String value() A string representation of the example. This is mutually exclusive with the externalValue property, and ignored if the externalValue property is specified. If the media type associated with the example allows parsing into an object, it may be converted from a string. Returns:String the value of the example

value

back to summary

public String value()

A string representation of the example.

This is mutually exclusive with the externalValue property, and ignored if the externalValue property is specified.

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

Returns:String: the value of the example

public @Interface ExampleObject

Method Summary

Method Detail