convention_builder
v2.0.0
Published
Helper tools that offer a high level interface that transforms a convention description into it's json schema.
Downloads
89
Maintainers
Readme
FarmOS Convention Schema Builder
This library is the main code component in our farmos_convention_publisher project.
It allows a user to create complex Farm data schemata using the FarmOs entities, which are already abstracted into JSON Schema files.
The objects that abstract this process have many added functionalities, such as the generation of rich react documentation, standalone schema validators and versioning.
Some Characteristics
Versioning
Al conventions and overlays are fully versioned.
This implies a version attribute in the defining object will ensure they are stored in a subfolder with the version name inside the adequate folder (with the convention/overlay name) in the outputs section.
The assumed way to store versions is by using git tags.
The rebuild scripts will grab each tag for each convention and build all versions using the mentioned subfolders.
