Skip to content

Schemas for data validation

The main goal: validate data created via cli and watcher

Scenario:

Hardocs via cli generates and automatically new data entries via a watcher. For instance if I create a new CAD folder under src/CAD a new entry in a yaml, eventually a form will be created. The user enters data in the yaml and the a json file is updated with the new file created. A project's design data is among other things, and I would say mainly an aggregate of parts, and subassemblies. When the user updates the yaml file (form) of parts data, it should be validated via schema.

Minimum things that describe a part and should be implemented in schema:

  • Id
  • Part Name
  • Part repository(a link where the package can be found and downloaded)
  • Part image
  • Datasheet(if possible)
  • Link to datasheet to download
  • Display if there is CAM and/ or CAD file
  • Author of the part
  • Version
  • Description Please add more, but these gives an overview
  • tags (these could be standardized)
  • new tags (users might want to create new tags)

A project can have many of these fields as well. Say for instance that a part is generated within the scope of a project. If new parts are created within a project scope, then those new parts should inherit the authors, licenses, etc.