Summary

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

Details

Page properties

Content

...	...	@@ -18,7 +18,7 @@
18	18	=== The openMINDS schema template syntax ===
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##**.
	21	+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##**.
22	22
23	23	(% style="text-align: justify;" %)
24	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 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).
...	...	@@ -38,13 +38,13 @@
38	38	{{code language="json"}}
39	39	{
40	40	"properties": {
41		- "propertyNameA": {},
42		- "propertyNameB": {},
43		- "propertyNameC": {}
	41	+ "propertyNameA": {},
	42	+ "propertyNameB": {},
	43	+ "propertyNameC": {}
44	44	},
45	45	"required": [
46		- "propertyNameA",
47		- "propertyNameC"
	46	+ "propertyNameA",
	47	+ "propertyNameC"
48	48	]
49	49	}
50	50	{{/code}}
...	...	@@ -90,30 +90,24 @@
90	90	How to define the expected value of a property will be explained for the different property types in the following sections.
91	91
92	92	(% style="text-align: justify;" %)
93		-===== String properties =====
	93	+===== Defining expected values =====
94	94
95	95	(% style="text-align: justify;" %)
96		-(//**coming soon**//)
	96	+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.
97	97
98	98	(% style="text-align: justify;" %)
99		-===== Numerical properties =====
	99	+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:
	100	++ **##"string"##**
	101	++ **##"number"##**
	102	++ **##"integer"##**
	103	++ **##"array"##**
	104	++ **##"boolean"##**
	105	++ **##"null"##**
	106	++ **##"object"##**
100	100
101		-(% style="text-align: justify;" %)
102		-(//**coming soon**//)
	108	+Also very similar to JSON-Schema, additional type-specific keys can be used to set further requirements for the expected value. H
103	103
104		-(% style="text-align: justify;" %)
105		-===== Object properties =====
106	106
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		-
117	117	=== The openMINDS integration pipeline ===
118	118
119	119	(//**coming soon**//)