Compile JSON documents

To compile metadata documents, first load a schema selecting MetaStore schemas or Local documents buttons. After a metadata schema is selected or loaded it is rendered as a simple form to fill.

MetaStore's schema selection and loading

The editor offers a set of useful tools to enhance the form visualization and compilation process.

Accordions allow to collapse or expand groups of fields
Load .json document button allows to fill the form (or part of it) by loading a .json file from computer storage
Validation takes place whenever changes are made during form compilation. Mandatory fields are indicated with an asterisk*, and errors, descriptions/suggestions are displayed for each field.

Rest API

Metadata editor exposes a rest endpoint for form compilation. It is possible to reach the API documentation and test it by clicking on on top-right corner. See more details here

Lock mode

Clicking on we enter in lock mode , where it is possible to select each single field via checkboxes.

Mask checkboxes and boolean fields

Field selection and boolean values in metadata schemas are depicted using checkboxes. Selected checkboxes, appearing small and gray, denote mask selection, while checked checkboxes, shown larger and blue, signify boolean values within metadata schemas.

Mask (left) and a boolean field (right) checkboxes

In this mode we can perform some actions on the form:

Metadata editor in default (left) and lock (right) mode

Select fields checking them: for each schema, a mask is established to indicate the 'check status' of individual fields. This mask persists and is loaded with the most recent checking pattern when a schema is chosen. Fields are unchecked by default if no mask is defined for a specific schema.
hide unchecked fields and make only the selected ones visible (click to show hidden fields)
clear all checked fields (selected fields are not touched)
Merge .json document load .json file to populate the form, in this case only the unchecked fields remain unchanged, and all other fields are overwritten. It's important to note that checked fields are left as they are if the loaded .json document used for merging doesn't include them.

Disabling lock mode

The changes made in lock mode , like hiding or deleting fields, remains when lock mode is turned off by clicking on (e.g. hidden fields in lock mode are also hidden in default mode )

Rest API in lock mode

When the lock mode is activated, the fields that are unchecked will stay the same, regardless of any attempts to update them using the rest API with new values.

Mask behaviour for arrays of objects

In arrays of objects, the mask is unique and identical for each array entry. It is not possible to apply different mask selections to individual entries.

Example of array of object appearence in Metadata editor