RESTBase/config.yaml schema

This page documents the schema used by  for RESTBase.

file is basically for Service-runner, so there are three things to do: The first one is configuring Service-runner, the second one is registering a RESTBase as a service for Service-runner and the third one is configuring the RESTBase.

Clause

 * Placement

A list of maps for services. The services can be either RESTBase, Citoid, Mathoid or Cxserver so on. This page only treats  service.

Same as Service-runner's  clause, see the document for further details.

Service Configurations
Must set like belew for RESTBase:

Clause

 * Placement

A configurations map for RESTBase, not for Service-runner.
 * - TODO
 * - TODO
 * - TODO
 * - TODO
 * - TODO
 * - TODO
 * - TODO
 * - See  clause below.

Clause

 * Placement

A map with keys are filters or paths.

Clause

 * Placement

A list of filters for the allowed routes. The below filters are automatically added:

See also.

Clause

 * Placement

A list of filters for the allowed requests. You can use the below filters as convenience way:

See also.

Clause

 * Placement

See also.

General filter configurations
If  is   and   is given,   is loaded.


 * TODO
 * TODO
 * TODO

Clause

 * Placement

A map with keys for the end points.

Path Configuration
A map that can has.

Clause
A list of modules.

Module Configurations
A map.

module
must be  or.


 * For sqlite configuration, see https://www.npmjs.com/package/restbase-mod-table-sqlite#configuration.
 * For cassandra configuration, see https://www.npmjs.com/package/restbase-mod-table-cassandra#configuration.

Clause

 * Placement

Same as Service-runner's clause, see the document for further details.

Clause

 * Placement

Same as Service-runner's  clause, see the document for further details.

Clause

 * Placement

Same as Service-runner's  clause, see the document for further details.

Clause

 * Placement

Same as Service-runner's  clause, see the document for further details.

Clause

 * Placement

Same as Service-runner's  clause, see the document for further details.

Clause

 * Placement

Same as Service-runner's  clause, see the document for further details.

Clause

 * Placement

Same as Service-runner's  clause, see the document for further details.

Clause

 * Placement