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
Retrieve an ordered list of all base uri parameters regardless of whether they are described in baseUriParameters or not
Consider a fragment of RAML specification:
version: v1
baseUri: https://{organization}.example.com/{version}/{service}
baseUriParameters:
service:
Here version and organization are base uri parameters which are not described in the baseUriParameters node,
but they are among Api.allBaseUriParameters().
Protocols used by the API. Returns the protocols property value if it is specified.
Otherwise, returns protocol, specified in the base URI.
Retrieve all resource types including those defined in libraries
Retrieve all resources of the Api
Retrieve all traits including those defined in libraries
Declarations of annotation types for use by annotations
Most of RAML model elements may have attached annotations decribing additional meta data about this element
A URI that's to be used as the base of all the resources' URIs. Often used as the base of the URL of each resource, containing the location of the API. Can be a template URI.
Named parameters used in the baseUri (template)
Get child resource by its relative path
object representing class of the node
A longer, human-friendly description of the API
Additional overall documentation for the API
YAML string representing the node
Array of errors
Equivalent API with traits and resource types expanded
Location of a valid RAML API definition (or overlay or extension), the extension is applied to
Actual name of instance interface
The default media type to use for request and response bodies (payloads), e.g. "application/json"
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
The protocols supported by the API
Remove node from children set
node to be removed
Declarations of resource types for use within this API
The resources of the API, identified as relative URIs that begin with a slash (/). Every property whose key begins with a slash (/), and is either at the root of the API definition or is the child property of a resource property, is a resource property, e.g.: /users, /{groupId}, etc
for user class instances returns object representing actual user class
Scalar properties annotations accessor
Alias for the equivalent "types" property, for compatibility with RAML 0.8. Deprecated - API definitions should use the "types" property, as the "schemas" alias for that property name may be removed in a future RAML version. The "types" property allows for XML and JSON schemas.
The security schemes that apply to every resource and method in the API
Declarations of security schemes for use within this API.
Short plain-text label for the API
Declarations of traits for use within this API
Declarations of (data) types for use within this API
contains description of why extension exist
The version of the API, e.g. 'v1'
Generated using TypeDoc