@Target(value={}) @Retention(value=RUNTIME) @Inherited public @interface ExampleObject
Modifier and Type | Optional Element and Description |
---|---|
String |
description
Long description for the example.
|
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 in a map.
|
String |
ref
Reference value to an Example object.
|
String |
summary
A brief summary of the purpose or context of the example
|
String |
value
A string representation of the example.
|
public abstract String name
The name is REQUIRED when the example is defined within Components
. The
name will be used as the key to add this example to the 'examples' map for reuse.
public abstract String summary
public abstract String description
public abstract String value
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.public abstract String externalValue
This is mutually exclusive with the value property.
public abstract String ref
This property provides a reference to an object defined elsewhere. This property and all other properties are mutually exclusive. If other properties are defined in addition to the ref property then the result is undefined.
Copyright © 2017 – 2020 Eclipse Foundation. All rights reserved.
Use is subject to license terms.