A resource node is one that begins with the slash and is either at the root of the API definition or a child of a resource node. The "schemas" and "types" nodes are mutually exclusive and synonymous: processors MUST NOT allow both to be specified at the root-level of an API definition.
We recommended using the "types" node instead of "schemas" because the schemas alias is deprecated and might be removed in a future RAML version.
The consensus of specification authors and RAML 0.8 users determines the contents of this document.
We strongly recommend that implementers and users of the RAML 0.8 specification update their software and API definitions to the RAML 1.0 specification.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in IETF RFC 2119 "Key words for use in RFCs to Indicate Requirement Levels".
In this specification, API definition means an API using this specification. REST is used in the context of an API implemented using some or all of the principles of REST (Representational State Transfer), which was introduced and first defined in 2000 in Chapter 5, REST, of the doctoral dissertation by Roy Fielding. A template URI refers to a URI parameter, which is a variable element, enclosed in curly brackets ( This specification describes the RESTful API Modeling Language (RAML).
The root section also defines assets used elsewhere in the RAML document, such as types and traits.
Nodes in a RAML-documented API definition MAY appear in any order.
This example shows a small part of a RAML API definition for the Git Hub v3 public API.A resource is the conceptual mapping to an entity or set of entities. RAML is a human- and machine-readable language for the definition of a RESTful application programming interface (API).RAML is designed to improve the specification of the API by providing a format that the API provider and API consumers can use as a mutual contract.The OPTIONAL documentation node includes a variety of documents that serve as user guides and reference documentation for the API.Such documents can clarify how the API works or provide technical and business context.