-
Notifications
You must be signed in to change notification settings - Fork 11
User Guide
This user guide provides an basic overview of our tool.
You can check our our web playground at this link
There you can select a schema of your choice.
Note that we currently only support schemas using the newest draft 2020-12, but if you use an older draft, you can still try to make it work by just switching the version in the $schema field.
If you want to change your schema at a later point, you can go to the schema editor and click on the folder icon.
Based on the schema you selected, the GUI of the file editor is generated. For example, if you choose the 'Self-Driving Vehicle' schema from our examples, you will find all the properties defined by the schema in the GUI panel of the file editor.
If you modify data using the GUI panel, you can observe the changes in the file on the left-hand side in the code editor.
The GUI panel on the right hand side will ensure that your file is a valid according to the schema you chose. If any schema violations occur, the errors will be highlighted.
To modify the schema, you can edit or create the schema in the Schema Editor. Checkout the JSON schema documentation to learn about JSON schema and how to use it. If you switch back to the File Editor after making changes, you will see those changes reflected in the GUI editor.
You can also explore the 'Settings' view to configure preferences, such as data format (JSON or YAML), maximum depth, font size, and more.