mirror of https://github.com/Telecominfraproject/ols-ucentral-schema.git synced 2026-01-27 10:21:47 +00:00

Go to file

Oleksandr Mazur 4e9d466c81 Extend schema to add dynamic authorization (CoA) support

- Extend schema/switch.yml to support configuring
  DAC list (origin of CoA and DM messages), as well as
  configiguring DAS (port on which receive CoA + DM) etc.
- Extend state/unit.yml to report back to the cloud
  current DAS configuration and DAC config.

Signed-off-by: Oleksandr Mazur <oleksandr.mazur@plvision.eu>

2024-02-05 14:46:18 +02:00

command

cmd_rrm.uc: do not enforce a channel

2023-09-28 14:52:40 +02:00

jsdoc

renderer: restructure and extend documentation

2021-12-05 09:45:06 +01:00

renderer

ieee8021x: rework render code

2023-10-05 12:15:46 +02:00

schema

Extend schema to add dynamic authorization (CoA) support

2024-02-05 14:46:18 +02:00

state

Extend schema to add dynamic authorization (CoA) support

2024-02-05 14:46:18 +02:00

system

add delta counters for upstream vlan interfaces

2023-10-05 10:22:09 +02:00

.gitignore

do not ignore pretty jsons

2023-09-22 18:24:37 +02:00

generate-example.uc

generate-reader, generate-example: introduce new uc-portrange format

2022-04-20 12:44:17 +02:00

generate-reader.uc

generate-reader, generate-example: introduce new uc-portrange format

2022-04-20 12:44:17 +02:00

generate.sh

only generate docs if the tool is installed

2021-10-13 16:36:49 +02:00

jsdoc.conf.json

jsdoc: add proper ucode->JS transpiler

2021-12-05 09:45:06 +01:00

merge-schema.py

schema: allow generating jsonschema with no $ref tags in it

2021-06-05 08:20:22 +02:00

README.md

Update README.md

2022-10-26 17:30:16 +02:00

schemareader.uc

ieee8021x: rework render code

2023-10-05 12:15:46 +02:00

ucentral.schema.full.json

ieee8021x: rework render code

2023-10-05 12:15:46 +02:00

ucentral.schema.json

OLS uCentral Schema: initial commit

2023-10-05 19:04:49 -07:00

ucentral.schema.pretty.json

ieee8021x: rework render code

2023-10-05 12:15:46 +02:00

ucentral.state.pretty.json

do not ignore pretty jsons

2023-09-22 18:24:37 +02:00

README.md

uCentral Schema

Collection of JSON schemas and ucode template (utpl) files used by uCentral for validating the data model and rendering incoming configuration JSON into UCI batch sequences.

This software is a part of the OpenWiFi AP NOS.

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
renderer/* - renderer sources and templates
command/* - predefined command implementations, e.g. invoked by ucentral-client
system/* - scripts to generate system information (e.g. state, telemetry, health, capabilities)