OLG uCentral Schema

Collection of JSON schemas used by uCentral for validating the data model. Rendering of configuration JSON into device-specific output is performed by separate flavour-specific renderers.

Building

Dependencies

In order to run the test cases you will need the following tools:

• ucode
• ucentral-jsonschema
• jsonlint-php
• pip3 install jsonschema2md
• pip3 install json-schema-for-humans
• pip3 install python-json2yaml

Unit testing

./run_tests.sh

Documentation

JSDoc is used to generate API documentation with a ucode transpiler (ucode-transpiler.js), configured by jsdoc.conf.json.

Additional JSON schema docs are generated using json-schema-for-humans via the script generate.sh.

Developer Notes

Generated documentation

• JSDoc: https://ucentral.io/docs/
• schema object: http://ucentral.io/docs/ucentral-schema.html
• state object: https://ucentral.io/docs/ucentral-state.html

Installed files

The following ucode scripts are installed to the AP:

• schemareader.uc - autogenerated schema reader
• command/* - predefined command implementations, e.g. invoked by ucentral-client
• system/* - scripts to generate system information (e.g. state, telemetry, health, capabilities)