Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -111,30 +111,40 @@
111	111	=== The openMINDS schema template syntax ===
112	112
113	113	(% style="text-align: justify;" %)
114		-All openMINDS metadata models use a light-weighted schema template syntax for defining the expected metadata. The correspondingly formatted schema files use the extension: **##.schema.tpl.json##**.
	114	+All openMINDS metadata models are defined using a light-weighted schema template syntax. Although this schema template syntax is inspired by JSON-Schema, it outsources most schema technicalities to be handled in the openMINDS integration pipeline, making the openMINDS schemas more human-readable, especially for untrained eyes.
115	115
116	116	(% style="text-align: justify;" %)
117		-Although, as the file extension suggests, this openMINDS schema template syntax is inspired by JSON-Schema, it facilitates or even excludes technical aspects making the openMINDS schemas more human-readable, especially for untrained eyes. Behind the scenes, within the openMINDS integration pipeline (cf. below), this schema template syntax is then interpreted and flexibly translated to various formal metadata formats (e.g., JSON-Schema).
	117	+The few remaining customized technical properties which need additional interpretation or translation to a formal schema languages (e.g. JSON-Schema) have an underscore as prefix (e.g., **##"_type"##**). Within the openMINDS integration pipeline (cf. below), the schema template syntax is interpreted, extended and flexibly translated to various formal schema languages. All further specifications of the openMINDS schema template syntax are described below.
118	118
119	119	(% style="text-align: justify;" %)
120		-Despite the simplification in comparison to JSON-Schema, the openMINDS schema templates are also, at the core, specially formatted JSON files using a particular syntax, meaning special key-value pairs that define the validation rules of a schema. Please find in the following a full documentation of the openMINDS schema template syntax and how it's key-value pairs need to be defined and interpreted.
	120	+All openMINDS schemas need to have the extension **##.schema.tpl.json##** and each schema is defined as a nested associative array (dictionary) with the following conceptual structure:
121	121
	122	+{{code language="json"}}
	123	+{
	124	+ "_type": "https://openminds.ebrains.eu/LABEL_OF_METADATA_MODEL/SCHEMA_NAME",
	125	+ "properties": {
	126	+ "PROPERTY_NAME": {
	127	+ "type": "DATA_TYPE",
	128	+ "_instruction": "METADATA_ENTRY_INSTRUCTION"
	129	+ },
	130	+ "required": [
	131	+ "PROPERTY_NAME"
	132	+ ]
	133	+}
	134	+{{/code}}
	135	+
122	122	(% style="text-align: justify;" %)
123		-For the more inexperienced programmers, let's start by explaining first some general terms that will be later used in the openMINDS schema template syntax specification. More experienced programmers can of course skip these explanations and jump directly further down.
	137	+**##"_type"##** defines the schema type (or namespace) with the depicted naming convention, where the label of the respective openMINDS metadata model (e.g., **##"core"##**) and the schema name (format: UpperCamelCase; e.g. **##"Person"##**) have to be specified. Obviously, the schema name should be meaningful and provide some insides into what metadata content the schema covers.
124	124
125		-**What is a string, an integer, a float or a boolean?**
	139	+(% style="text-align: justify;" %)
	140	+Under **##"properties"##** a nested associative array is defined, where each key defines the property name (format: lowerCamelCase; e.g. **##"givenName"##**). The corresponding value is again a nested associative array defining the expected data **##"type"##** (cf. below) and the **##"_instructions"##** for entering the correct metadata for the respective property.
126	126
127		-**What is a key-value pair?**
	142	+(% style="text-align: justify;" %)
	143	+Under **##"required"##** a list of property names can be provided that are obligatory to be present in a correctly instantiated metadata instance of the respective schema. If none of the properties are required, this key-value pair does not have to be specified.
128	128
129		-**What is a list?**
	145	+(% style="text-align: justify;" %)
	146	+Now, depending on the expected data type additional constraints can be made for the metadata entry of a respective property. Currently, the openMINDS schema template syntax supports the following data types: **##"string"##**, ##**"integer"##**, **##"float"##**, **##"boolean"##**, **##"array"##** and **##"object"##**.
130	130
131		-**What is a dictionary?**
132		-
133		-**What is a JSON?**
134		-
135		-
136		-
137		-
138	138	=== The openMINDS integration pipeline ===
139	139
140	140	(//**coming soon**//) If you'd like to learn more about the openMINDS integration pipeline, especially if you'd like to contribute to it, please get in touch with us (the openMINDS development team) via the issues on the openMINDS or openMINDS_generator GitHub or the support email: openminds@ebrains.eu