RAML version of the node. "RAML10" for RAML 1.0 and "RAML08" for RAML 0.8.
baseUri of owning Api concatenated with completeRelativeUri
Retrieve an ordered list of all absolute uri parameters. Returns a union of Api.allBaseUriParameters()
for Api owning the Resource and Resource.allUriParameters().
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,
Thus, it is not among Resource.uriParameters(), but it is among Resource.allUriParameters().
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.
Get child method by its name
Get child resource by its relative path
Path relative to API root
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
Array of errors
Instantiation of applyed traits
Actual name of instance interface
Methods that can be called on this resource
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.
Api owning the resource as a sibling
Direct ancestor in RAML hierarchy
Parent resource for non top level resources
Relative URL of this resource from the parent resource
Children resources
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
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.uriParameters().
Generated using TypeDoc