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
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.
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
A longer, human-friendly description of the security scheme part
An alternate, human-friendly name for the security scheme part
YAML string representing the node
Array of errors
Headers that allowed at this position
Instantiation of applyed traits
Actual name of instance interface
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 an API's protocols value for that single method by setting a different value for the fields.
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
Remove node from children set
node to be removed
Optional array of responses, describing the possible responses that could be sent.
for user class instances returns object representing actual user class
A list of the security schemas to apply, these must be defined in the securitySchemes declaration. To indicate that the method may be called without applying any securityScheme, the method may be annotated with the null securityScheme. Security schemas may also be applied to a resource with securedBy, which is equivalent to applying the security schemas to all methods that may be declared, explicitly or implicitly, by defining the resourceTypes or traits property for that resource.
Generated using TypeDoc