RAML version of the node
Append node as child
node to be appended
Append node as property value
node to be set as property value
name of property to set value for
Restrictions on where annotations of this type can be applied. If this property is specified, annotations of this type may only be applied on a property corresponding to one of the target names specified as the value of this property.
Most of RAML model elements may have attached annotations decribing additional meta data about this element
Provides default value for a property
object representing class of the node
A longer, human-friendly description of the type
The displayName attribute specifies the type display name. It is a friendly name used only for display or documentation purposes. If displayName is not specified, it defaults to the element's key (the name of the property itself).
YAML string representing the node
(Optional, applicable only for parameters of type string) The enum attribute provides an enumeration of the parameter's valid values. This MUST be an array. If the enum attribute is defined, API clients and servers MUST verify that a parameter's value matches a value in the enum array. If there is no matching value, the clients and servers MUST treat this as an error.
Array of errors
An example of this type instance represented as string or yaml map/sequence. This can be used, e.g., by documentation generators to generate sample values for an object of this type. Cannot be present if the examples property is present.
An example of this type instance represented as string. This can be used, e.g., by documentation generators to generate sample values for an object of this type. Cannot be present if the example property is present.
When extending from a type you can define new facets (which can then be set to concrete values by subtypes).
Value format
Whether the type represents annotation
Actual name of instance interface
Location of the parameter (can not be edited by user)
Kind of location
(Optional, applicable only for parameters of type number or integer) The maximum attribute specifies the parameter's maximum value.
(Optional, applicable only for parameters of type number or integer) The minimum attribute specifies the parameter's minimum value.
A numeric instance is valid against "multipleOf" if the result of the division of the instance by this keyword's value is an integer.
name of the parameter
Whether the element is an optional sibling of trait or resource type
For siblings of traits or resource types returns an array of optional properties names.
Direct ancestor in RAML hierarchy
Remove node from children set
node to be removed
Sets if property is optional or not
for user class instances returns object representing actual user class
Runtime representation of type represented by this AST node
Scalar properties annotations accessor
Alias for the equivalent "type" property, for compatibility with RAML 0.8. Deprecated - API definitions should use the "type" property, as the "schema" alias for that property name may be removed in a future RAML version. The "type" property allows for XML and JSON schemas.
Inlined supertype definition.
A base type which the current type extends, or more generally a type expression.
validate an instance against type
validate an instance against type
Generated using TypeDoc
Value MUST be a number. Indicate floating point numbers as defined by YAML.