RAML version of the node. "RAML10" for RAML 1.0 and "RAML08" for RAML 0.8.
Each response MAY contain a body property, which conforms to the same structure as request body properties (see Body). Responses that can return more than one response code MAY therefore have multiple bodies defined. For APIs without a priori knowledge of the response types for their responses, * /*
MAY be used to indicate that responses that do not matching other defined data types MUST be accepted. Processing applications MUST match the most descriptive media type first if * /*
is used.
Responses MUST be a map of one or more HTTP status codes, where each status code itself is a map that describes that status code.
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.
Array of errors
An API's methods may support custom header values in responses. The custom, non-standard HTTP headers MUST be specified by the headers property. API's may include the the placeholder token {?} in a header name to indicate that any number of headers that conform to the specified format can be sent in responses. This is particularly useful for APIs that allow HTTP headers that conform to some naming convention to send arbitrary, custom data.
true for codes < 400 and false otherwise
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
for user class instances returns object representing actual user class
Turns model node into an object.
Stringifyable object representation of the node.
Generated using TypeDoc