RAML version of the node. "RAML10" for RAML 1.0 and "RAML08" for RAML 0.8.
A resource or a method can override a base URI template's values. This is useful to restrict or change the default or parameter selection in the base URI. The baseUriParameters property MAY be used to override any or all parameters defined at the root level baseUriParameters property, as well as base URI parameters not specified at the root level.
object representing class of the node
The description attribute describes the intended use or meaning of the $self. This value MAY be formatted using Markdown.
An alternate, human-friendly name for the resource type
Array of errors
Instantiation of applyed traits
Actual name of instance interface
Methods that are part of this resource type definition
Name of the resource type
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.
Returns object representation of parametrized properties of the resource type
Direct ancestor in RAML hierarchy
for user class instances returns object representing actual user class
securityScheme may also be applied to a resource by using the securedBy key, which is equivalent to applying the securityScheme to all methods that may be declared, explicitly or implicitly, by defining the resourceTypes or traits property for that resource. To indicate that the method may be called without applying any securityScheme, the method may be annotated with the null securityScheme.
Turns model node into an object.
Stringifyable object representation of the node.
Instantiation of applyed resource type
Uri parameters of this resource
Instructions on how and when the resource type should be used.
Generated using TypeDoc