Interface Example
- All Superinterfaces:
Constructible
,Extensible
,Reference<Example>
Example
An object containing sample data for the related object.
In all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiondescription
(String description) Sets this Example's description property to the given string.externalValue
(String externalValue) Sets this Example's externalValue property to the given string.Returns the description property from an Example instance.Returns the externalValue property from an Example instance.Returns the summary property from an Example instance.getValue()
Returns the value property from an Example instance.void
setDescription
(String description) Sets this Example's description property to the given string.void
setExternalValue
(String externalValue) Sets this Example's externalValue property to the given string.void
setSummary
(String summary) Sets this Example's summary property to the given string.void
Sets this Example's value property to the given value.Sets this Example's summary property to the given string.Sets this Example's value property to the given value.Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible
addExtension, getExtensions, setExtensions
-
Method Details
-
getSummary
String getSummary()Returns the summary property from an Example instance.- Returns:
- short description of the example
-
setSummary
Sets this Example's summary property to the given string.- Parameters:
summary
- short description of the example
-
summary
Sets this Example's summary property to the given string.- Parameters:
summary
- short description of the example- Returns:
- the current Example object
-
getDescription
String getDescription()Returns the description property from an Example instance.- Returns:
- long description of the example
-
setDescription
Sets this Example's description property to the given string.- Parameters:
description
- long description of the example
-
description
Sets this Example's description property to the given string.- Parameters:
description
- long description of the example- Returns:
- the current Example object
-
getValue
Object getValue()Returns the value property from an Example instance.- Returns:
- embedded literal example object
-
setValue
Sets this Example's value property to the given value. The value field and externalValue field are mutually exclusive.- Parameters:
value
- a literal example object
-
value
Sets this Example's value property to the given value. The value field and externalValue field are mutually exclusive.- Parameters:
value
- a literal example object- Returns:
- the current Example object
-
getExternalValue
String getExternalValue()Returns the externalValue property from an Example instance.- Returns:
- URL that points to the literal example
-
setExternalValue
Sets this Example's externalValue property to the given string. The value field and externalValue field are mutually exclusive.- Parameters:
externalValue
- URL that points to the literal example
-
externalValue
Sets this Example's externalValue property to the given string. The value field and externalValue field are mutually exclusive.- Parameters:
externalValue
- URL that points to the literal example- Returns:
- the current Example object
-