OasExample

Undocumented in source.

Members

Variables

description
string description;

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

externalValue
string externalValue;

A URL that points to the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The value field and externalValue field are mutually exclusive.

ref_
string ref_;

A link to parameters defined in the [OasDocument's] components/examples.

summary
string summary;

Short description for the example.

value
Json value;

Embedded literal example. The value field and externalValue field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary.

Meta