Summary

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

Details

Page properties

Content

...	...	@@ -120,21 +120,29 @@
120	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		-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.
	123	+Let's start by going through the syntax of a simple openMINDS schema, the contactInformation.schema.tpl.json:
124	124
125		-**What is a string, an integer, a float or a boolean?**
	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}}
126	126
127		-**What is a key-value pair?**
	143	+(% style="text-align: justify;" %)
	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, the value has to be of type **##"string"##** {{footnote}}Strings are defined as characters between quotes **##"..."##**.{{/footnote}}). 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 formatted as **##"email"##** address {{footnote}}An email address, such as openminds@ebrains.eu, is made up from a local-part, the symbol **##@##**, and a domain, which may be a domain name or an IP address enclosed in brackets{{/footnote}}.
128	128
129		-**What is a list?**
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