Hide Comments

Terminology

Accessible

An element is accessible or in scope if it is defined in the same RAPID Model, or is defined in a sub-model that is explicitly imported into the current RAPID Model.

RAPID Model

For this specification, RAPID Model refers to a top-level RAPID-ML model, corresponding to an individual file and containing one or more Data Models, Resource APIs, or Definition Libraries.

RAPID-ML Specification

RAPID-ML Specification refers to this document.

Realization

Realizations are adaptations of canonical Data Structures in order to tailor them to a specific application context.  The realization is described by applying formally defined operations that maintain certain guarantees of conformance to the underlying data type.   Realization operations include:

Property Set, which specifies inclusion or exclusion of certain properties;
Reference Treatments, which represent reference properties as hyperlinks or embedded data; and
Constraints, which further restrict the value space or Cardinality of data properties in the context of a resource or Method.

REST

REST is used in the context of an API implemented using the principles of REST. The REST acronym stands for Representational State Transfer and was first introduced and defined in 2000 by Roy Fielding in his doctoral dissertation.

RAPID-ML supports, but does not enforce, fully RESTful APIs.  API designers are free to design APIs with appropriate tradeoffs among various architectural properties such as loose coupling, type safety, and ease of use.  Designers can also choose among various ways to formalize the API contract, using media types and link relations as prescribed by REST, or using less formal out-of-band information.

Created with Help & Manual 6 and styled with Premium Pack Version 2.51 © by EC Software