Annotation Interface ExampleObject
This object illustrates an example of a particular content
- See Also:
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionLong description for the example.A URL to point to an external document to be used as an example.A unique name to identify this particular example in a map.Reference value to an Example object.A brief summary of the purpose or context of the exampleA string representation of the example.
-
Element Details
-
name
String nameA unique name to identify this particular example in a map.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.- Returns:
- the name of this example
- Default:
- ""
-
summary
String summaryA brief summary of the purpose or context of the example- Returns:
- a summary of this example
- Default:
- ""
-
description
String descriptionLong description for the example. CommonMark syntax MAY be used for rich text representation.- Returns:
- a description of this example
- Default:
- ""
-
value
String valueA 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:
- the value of the example
- Default:
- ""
-
externalValue
String externalValueA 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:
- an external URL of the example
- Default:
- ""
-
ref
String refReference value to an Example object.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.
- Returns:
- reference to an example
- Default:
- ""
-