Summary

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

Details

Page properties

Content

...	...	@@ -10,65 +10,116 @@
10	10	Please find below a documentation of the layout and requirements needed to keep the openMINDS modularity, the syntax of the openMINDS schema template, as well as the openMINDS integration pipeline.
11	11	)))
12	12
13		-=== Overview of the openMINDS layout ===
	13	+=== The openMINDS umbrella ===
14	14
15	15	(% style="text-align: justify;" %)
16	16	In summary, openMINDS is the overall umbrella for a set of distributed GitHub repositories, each defining a particular metadata model for neuroscience research products.
17	17
18		-=== The openMINDS schema template syntax ===
	18	+(% style="text-align: justify;" %)
	19	+The main (or central) [[openMINDS GitHub repository>>https://github.com/HumanBrainProject/openMINDS||rel="noopener noreferrer" target="_blank"]] ingests all these GitHub repositories as submodules. Furthermore it defines the openMINDS vocabulary (**##vocab##**) used for **##types##** and **##properties##** across all schemas independent of their original repository (cf. below). And last but not least, it holds the schema representations for all supported metadata formats created by the openMINDS generator pipeline.
19	19
20	20	(% style="text-align: justify;" %)
21		-All openMINDS metadata models use a light-weighted schema template syntax for defining the metadata. The correspondingly formatted schema files use the extension: **##.schema.tpl.json##**.
	22	+For this to work smoothly for the existing, but also for all new openMINDS metadata models, the corresponding openMINDS submodules (GitHub repositories) have to meet the following requirements:
	23	+((% style="color:#7f8c8d" %)//**coming soon**//(%%))
22	22
	25	+=== The openMINDS vocabulary ===
	26	+
23	23	(% style="text-align: justify;" %)
24		-Although, as the file extension suggests, this openMINDS schema template syntax is inspired by JSON-Schema, it facilitates or even excludes technical aspects that are generally expected for the openMINDS schemas making it more human-readable, especially for untrained eyes.
	28	+((% style="color:#7f8c8d" %)//**coming soon**//(%%))
25	25
	30	+=== The openMINDS schema template syntax ===
	31	+
26	26	(% style="text-align: justify;" %)
27		-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). Please find in the following a full documentation of the openMINDS schema template syntax and how it needs to be interpreted.
	33	+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##**.
28	28
29	29	(% style="text-align: justify;" %)
30		-===== Target & context templates =====
	36	+Although, as the file extension suggests, this openMINDS schema template syntax is inspired by JSON-Schema, it facilitates or even excludes technical aspects that are generally expected for the openMINDS schemas making them 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).
31	31
32	32	(% style="text-align: justify;" %)
33		-All openMINDS schemas have to have a **##"_type"##** to be recognized as target templates. In other words, the **##"_type"##** is used to define the openMINDS namespace of a corresponding schema using the following naming convention:
	39	+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.
34	34
35		-(% style="text-align: center;" %)
36		-**##"_type": "https:~/~/openminds.ebrains.eu/<<schema-model>>/<<schema-name>>"##**,
	41	+(% style="text-align: justify;" %)
	42	+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.
37	37
38	38	(% style="text-align: justify;" %)
39		-where **##<<schema-model>>##** has to be replaced with the label of the openMINDS metadata model the corresponding schema belongs to and **##<<schema-name>>##** exchanged with the label of that schema.
	45	+===== Target & concept templates =====
40	40
41	41	(% style="text-align: justify;" %)
42		-If an openMINDS schema template file //DOES NOT// define a **##"_type"##**, it is interpreted as a context template which requires an extension to become a target template.
	48	+Same as in JSON-Schema, all openMINDS schema templates define the expected name (written in **##lowerCamelCase##**) and value of the metadata, typically called property, under the key **##properties##** as nested dictionaries. Furthermore, the names of obligatory metadata can be listed under the key **##required##**. Here a generalized example:
43	43
	50	+{{code language="json"}}
	51	+{
	52	+ "properties": {
	53	+ "propertyNameA": {},
	54	+ "propertyNameB": {},
	55	+ "propertyNameC": {}
	56	+ },
	57	+ "required": [
	58	+ "propertyNameA",
	59	+ "propertyNameC"
	60	+ ]
	61	+}
	62	+{{/code}}
	63	+
44	44	(% style="text-align: justify;" %)
45		-Context templates are and should be used when multiple openMINDS schemas (target templates) have the same subset of properties. This common subset of properties can then be defined within a single context schema instead of each target template which facilitates the long-term maintenance of these properties.
	65	+In addition, an openMINDS schema //has to have// a key **##"_type"##** to be recognized as **target template**. In other words, the **##"_type"##** is used to define the openMINDS namespace of a corresponding schema using a particular naming convention. Here again a generalized example:
46	46
	67	+{{code language="json"}}
	68	+{
	69	+ "_type": "https:~/~/openminds.ebrains.eu/<<schema-model>>/<<schema-name>>",
	70	+ "properties": {}
	71	+}
	72	+{{/code}}
	73	+
47	47	(% style="text-align: justify;" %)
48		-===== String properties =====
	75	+Note that **##<<schema-model>>##** has to be replaced with the label of the openMINDS metadata model to which the corresponding schema belongs to, and **##<<schema-name>>##** has to be replaced with the corresponding name of the schema (written in **##CamelCase##**).
49	49
50	50	(% style="text-align: justify;" %)
51		-(//**coming soon**//)
	78	+If an openMINDS schema template //does not// define a key **##"_type"##** (as in the first example above), it is interpreted as a **concept template** which //has to be// extended to a target template.
52	52
53	53	(% style="text-align: justify;" %)
54		-===== Numerical properties =====
	81	+Concept templates are and should be used when multiple target templates have the same subset of properties, because they facilitate the long-term maintenance of those shared properties: Instead of defining the same properties repeatedly within multiple target templates, the common subset can be defined within a single concept template and passed on to all extending target templates.
55	55
56	56	(% style="text-align: justify;" %)
57		-(//**coming soon**//)
	84	+To define that a target template is the extension of a concept template, the target template can state under **##"_extends"##** the relative path to the concept template. For example, the openMINDS core target template **##Dataset##** extends the core concept template **##researchProduct##** as indicated here:
58	58
	86	+{{code language="json"}}
	87	+{
	88	+ "_type": "https:~/~/openminds.ebrains.eu/core/Dataset",
	89	+ "_extends": "products/researchProduct.schema.tpl.json"
	90	+}
	91	+{{/code}}
	92	+
59	59	(% style="text-align: justify;" %)
60		-===== Object properties =====
	94	+Note that this convention requires the concept and corresponding target templates to be located in the same openMINDS metadata model repository. Note also that for properties, the following rules apply for target and concept template:
61	61
	96	+1. A concept template has to define some properties which will be inherited by all extending target templates.
	97	+1. If a concept template additionally states that some of these properties are required, all extending target templates will require the same properties.
	98	+1. A target template can require properties of the concept template, that are not explicitly required within the concept template. In such a case, the other target templates extending the same concept template will not require those properties.
	99	+1. A target template can (but does not have to) define and require additional properties that were not defined and required in the concept template. These additionally defined and required properties will not be shared with the other target templates extending the same concept template.
	100	+
62	62	(% style="text-align: justify;" %)
63		-(//**coming soon**//)
	102	+How to define the expected value of a property will be explained for the different property types in the following sections.
64	64
65	65	(% style="text-align: justify;" %)
66		-===== Property arrays =====
	105	+===== Defining expected values =====
67	67
68	68	(% style="text-align: justify;" %)
69		-(//**coming soon**//)
	108	+The expected value of a property can be defined in large parts in the same way as in JSON-Schema, with some openMINDS syntax specific simplifications and modifications.
70	70
	110	+(% style="text-align: justify;" %)
	111	+On the first level, the **##"type"##** of the expected property value needs to be defined. In principle, the openMINDS template syntax supports the same value types as JSON-Schema Draft 7.0, meaning:
	112	++ **##"string"##**
	113	++ **##"number"##**
	114	++ **##"integer"##**
	115	++ **##"array"##**
	116	++ **##"boolean"##**
	117	++ **##"null"##**
	118	++ **##"object"##**
71	71
	120	+Also very similar to JSON-Schema, additional type-specific keys can be used to set further requirements for the expected value. H
	121	+
	122	+
72	72	=== The openMINDS integration pipeline ===
73	73
74	74	(//**coming soon**//)