orion

Config-based API server framework


Project maintained by ctjong Hosted on GitHub Pages — Theme by mattgraham

Orion Documentation

Configuration Options

A configuration module is required to give the application the necessary information about your project. This module should specify the connection strings, authentication and authorization settings, user roles and access levels, and most importantly, the data models.

Below is the list of settings to be included in a configuration module:

Entity Configuration

Here are the properties that must/may be included in an entity configuration object:

Field Configuration

Here are the properties that must/may be included in a field configuration object:

Default Fields and Entities

Here is a list of default fields and entities that are being automatically added to your configuration at runtime.

All values in the defaultEntities and defaultFields are overridable in your config. If an override is specified, the config values will be merged using Object.assign();