Summary

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

Details

Page properties

Content

...	...	@@ -10,27 +10,15 @@
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		-=== The openMINDS umbrella ===
	13	+=== Overview of the openMINDS layout ===
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		-(% 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.
20		-
21		-(% style="text-align: justify;" %)
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**//(%%))
24		-
25		-=== The openMINDS vocabulary ===
26		-
27		-(% style="text-align: justify;" %)
28		-((% style="color:#7f8c8d" %)//**coming soon**//(%%))
29		-
30	30	=== The openMINDS schema template syntax ===
31	31
32	32	(% style="text-align: justify;" %)
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##**.
	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##**.
34	34
35	35	(% style="text-align: justify;" %)
36	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).
...	...	@@ -50,13 +50,13 @@
50	50	{{code language="json"}}
51	51	{
52	52	"properties": {
53		- "propertyNameA": {},
54		- "propertyNameB": {},
55		- "propertyNameC": {}
	41	+ "propertyNameA": {},
	42	+ "propertyNameB": {},
	43	+ "propertyNameC": {}
56	56	},
57	57	"required": [
58		- "propertyNameA",
59		- "propertyNameC"
	46	+ "propertyNameA",
	47	+ "propertyNameC"
60	60	]
61	61	}
62	62	{{/code}}
...	...	@@ -102,24 +102,30 @@
102	102	How to define the expected value of a property will be explained for the different property types in the following sections.
103	103
104	104	(% style="text-align: justify;" %)
105		-===== Defining expected values =====
	93	+===== String properties =====
106	106
107	107	(% style="text-align: justify;" %)
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.
	96	+(//**coming soon**//)
109	109
110	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"##**
	99	+===== Numerical properties =====
119	119
120		-Also very similar to JSON-Schema, additional type-specific keys can be used to set further requirements for the expected value. H
	101	+(% style="text-align: justify;" %)
	102	+(//**coming soon**//)
121	121
	104	+(% style="text-align: justify;" %)
	105	+===== Object properties =====
122	122
	107	+(% style="text-align: justify;" %)
	108	+(//**coming soon**//)
	109	+
	110	+(% style="text-align: justify;" %)
	111	+===== Property arrays =====
	112	+
	113	+(% style="text-align: justify;" %)
	114	+(//**coming soon**//)
	115	+
	116	+
123	123	=== The openMINDS integration pipeline ===
124	124
125	125	(//**coming soon**//)