Example

struct Example {

string summary;

string description;

string value;

string externalValue;

bool parseJsonValue;

Json toJson();

static Example fromJson(Json src);

}

Members

Functions

toJson Json toJson(): Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

fromJson Example fromJson(Json src)

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.
parseJsonValue bool parseJsonValue;: True if the value should be treated as a json object or array
summary string summary;: Short description for the example.
value string 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

Source

See Implementation