Summary

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

Details

Page properties

Content

...	...	@@ -114,17 +114,37 @@
114	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##**.
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 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).
	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).
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.
	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.
121	121
122	122	(% style="text-align: justify;" %)
123		-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.
	123	+Let's start by going through the syntax of a simple openMINDS schema, the contactInformation.schema.tpl.json:
124	124
	125	+{{code language="json"}}
	126	+{
	127	+ "_type": "https://openminds.ebrains.eu/core/ContactInformation",
	128	+ "required": [
	129	+ "email"
	130	+ ],
	131	+ "properties": {
	132	+ "email": {
	133	+ "type": "string",
	134	+ "_formats": [
	135	+ "email"
	136	+ ],
	137	+ "_instruction": "Enter the email address of this person."
	138	+ }
	139	+ }
	140	+}
	141	+{{/code}}
	142	+
125	125	(% style="text-align: justify;" %)
126		-(//**coming soon**//)
	144	+The **##"_type"##** identifies the schema type or namespace for the particular schema. In **##"required"##** all property names have to be listed{{footnote}}A list is a data structure that is an ordered sequence of elements. Each element inside of a list is typically called an item. Lists are defined by having values between square brackets **##[ ]##**.{{/footnote}} that must be provided and filled out in a valid instance of this schema type (here, only the property **##"email"##** is required). Under **##"properties"##**, information about the expected value for each property defining the particular schema is given in a nested dictionary{{footnote}}A dictionary is a data structure that consists of an unordered collection of key:value pairs. Dictionaries are defined by having these key:value pairs between curly brackets **##{...}##**.{{/footnote}} (here, the only property is **##"email"##**). In this nested dictionary the **##"type"##** of the expected value should be specified (here, a value of type **##"string"##**{{footnote}}Strings are defined as characters between quotes **##"..."##**.{{/footnote}} is expected). For values of type **##"string"##** it is further possible to list the accepted formats of the **##"string"##** under **##"_formats"##** (here, the expected **##"string"##** value has to be an email).
127	127
128	128	=== The openMINDS integration pipeline ===
129	129
130		-(//**coming soon**//)
	148	+(//**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
	149	+
	150	+{{putFootnotes/}}