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
Most of RAML model elements may have attached annotations decribing additional meta data about this element
Some method verbs expect the resource to be sent as a request body. For example, to create a resource, the request must include the details of the resource to create. Resources CAN have alternate representations. For example, an API might support both JSON and XML representations. A method's body is defined in the body property as a hashmap, in which the key MUST be a valid media type.
object representing class of the node
The displayName attribute specifies the trait 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
Headers that allowed at this position
Instantiation of applyed traits
Actual name of instance interface
Name of the trait
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
A method can override the protocols specified in the resource or at the API root, by employing this property.
An APIs resources MAY be filtered (to return a subset of results) or altered (such as transforming a response body from JSON to XML format) by the use of query strings. If the resource or its method supports a query string, the query string MUST be defined by the queryParameters property
Specifies the query string needed by this method. Mutually exclusive with queryParameters.
Remove node from children set
node to be removed
Information about the expected responses to a request
for user class instances returns object representing actual user class
Scalar properties annotations accessor
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.
Instructions on how and when the trait should be used.
Generated using TypeDoc