Skip to content

Pavel-research/raml-specs-separated

Repository files navigation

RAML Specifications Separated

This repository contains an attempt to extract few parts of RAML specifications in separate mini specifications and to make them available as a building blocks for usage in describing new RAML dialects.

Concepts:

  • Includes - describe mechanism which may be used to bring structural includes into the language
  • Libraries - describes an abstract library fragment which may be used to bring library support into your dialect of RAML
  • Overlays&Extensions - describes extensions mechanism and additional semantic validation which is associated with abstract Overlay and Extension fragments.
  • Data Types - describes RAML type system, Type Declaration fragments.
  • Annotations - describes annotations and annotations types properties.

Mental Framework:

  • Metamodel - short description of mental framework which may be used to describe RAML dialect.

Examples:

  • Garages - example of the garage specifications language defined using this mental framework
  • REST minilang - example of how you may define RAML Dialect by using only RAML terms.