org.raml.v2.model.v10.datamodel

Interface ExampleSpec

All Superinterfaces:

AbstractWrapperNode, Annotable, BasicFragmentNode, BasicNode

public interface ExampleSpec
extends Annotable

Method Summary

Methods

Modifier and Type	Method and Description
String	name() Example identifier, if specified
Boolean	strict() By default, examples are validated against any type declaration.
TypeInstance	structuredContent() Returns object representation of example, if possible
String	value() String representation of example

Methods inherited from interface org.raml.v2.model.v10.common.Annotable

annotations

Methods inherited from interface org.raml.v2.model.v10.fragment.BasicFragmentNode

fragment

Methods inherited from interface org.raml.v2.model.v10.core.BasicNode

meta, optional, optionalProperties, parent, toJSON

Method Detail

value

String value()

String representation of example

strict

Boolean strict()

By default, examples are validated against any type declaration. Set this to false to allow examples that need not validate.

name

String name()

Example identifier, if specified

structuredContent

TypeInstance structuredContent()

Returns object representation of example, if possible