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
Returns security schemes, resource or method is secured with. If no security schemes are set at resource or method level,
returns schemes defined with securedBy at API level.
Retrieve an ordered list of all uri parameters including those which are not described in the uriParameters node.
Consider a fragment of RAML specification:
/resource/{objectId}/{propertyId}:
uriParameters:
objectId:
Here propertyId uri parameter is not described in the uriParameters node,
but it is among Resource.allUriParameters().
Most of RAML model elements may have attached annotations decribing additional meta data about this element
object representing class of the node
The displayName attribute specifies the resource 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
Array of errors
A list of the traits to apply to all methods declared (implicitly or explicitly) for this resource. Individual methods may override this declaration
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.
Direct ancestor in RAML hierarchy
Remove node from children set
node to be removed
for user class instances returns object representing actual user class
Scalar properties annotations accessor
The security schemes that apply to all methods declared (implicitly or explicitly) for this resource.
The resource type which this resource inherits.
Detailed information about any URI parameters of this resource
Instructions on how and when the resource type should be used.
Generated using TypeDoc