package metamodel
- Alphabetic
- Public
- All
Value Members
-
object
ExtensionModel
extends ExtensionLikeModel
An extension broadens a RAML API definition by adding to, or modifying aspects of its behavior and other functionality.
An extension broadens a RAML API definition by adding to, or modifying aspects of its behavior and other functionality. An extension can be useful in separating a core, broadly-available API from layers of functionality available to more restricted audiences, for creating variants of an API for somewhat different purposes, or for specifying instance-specific nodes of an API, such as its service endpoint (URL) without altering its pure interface definition document.
- object FragmentsTypesModels
-
object
OverlayModel
extends ExtensionLikeModel
An overlay adds or overrides nodes of a RAML API definition while preserving its behavioral, functional aspects.
An overlay adds or overrides nodes of a RAML API definition while preserving its behavioral, functional aspects. Certain nodes of a RAML API definition specify the behavior of an API: its resources, methods, parameters, bodies, responses, and so on. These nodes cannot be changed by applying an overlay. In contrast, other nodes, such as descriptions or annotations, address concerns beyond the functional interface, such as the human-oriented descriptive documentation in some language, or implementation or verification information for use in automated tools. These nodes can be changed by applying an overlay.