Summary

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

Details

Page properties

Content

...	...	@@ -120,29 +120,20 @@
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		-Let's start by going through the syntax of a simple openMINDS schema, the contactInformation.schema.tpl.json:
	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 to Specifications.
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}}
	125	+**What are strings, integers, floats or booleans?** Generally speaking strings, integers, floats or booleans are derived **data types**. A **string** is defined as a sequence of characters between quotes (e.g., ##"Is this a string? YES!"## or ##'thisIsAlsoAString'##). For a string, openMINDS accepts Unicode characters. An **integer** is a whole number, positive or negative, without decimals, of unlimited length (e.g., ##5##, ##-5## or ##1238921234##). A **float** represents a real number, written with a decimal point dividing the integer and fractional part, both of unlimited length (e.g., ##5.15##, ##-5.15## or ##1238921234.1345##). A **boolean** represents a logical proposition by means of the binary digits ##0## (##false##) and ##1## (##true##), especially in computing and electronics. How a boolean is written depends highly on the format or computational language.
142	142
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}}.
	127	+**What is a list or array?** A **list** is a data structure that is a mutable ordered sequence of values (also called items). The values of a list are typically defined between square brackets (e.g., ##[value1, value2, value3]##). Note that the values within a list do not have to have the same data type. In contrast, an **array** is a data structure that is a mutable unordered sequence of values of the same data type. What data types are accepted for values in a list or in an array is highly depending on the format or computational language.
145	145
	129	+**What is a key-value pair or an associative array?** A **key-value pair** (sometimes also called name-value pair, attribute-value pair, property-value pair, or field-value pair) is a basic data representation and standard language feature in computing languages, systems and applications. In most cases this concept is used to build an **associative array** (also called **dictionary**), meaning an unordered list of unique keys with associated values typically defined within curly brackets (e.g., ##{key1: value1, key3: value3, key2:value2}##). What data types are accepted for keys and values highly depends on the format or computational language. Note that a value could also be a data structure, such as a list, an array or an associative array.
	130	+
	131	+**What is JSON?** JSON is short for **J**ava**S**cript **O**bject **N**otation, a lightweight data-interchange format which is built on associative arrays with key-value pairs and lists. Each JSON file begins as associative array. The keys are separated from the values via a colon and key-value pairs are separated by a comma. While a key always has to be a string in double quotes, a value can be a string in double quotes, an integer, a float, a boolean (written as true or false), null, a list or an associative array. Nesting of these structures is unlimited. For more information please go to the official webpage: [[https:~~/~~/www.json.org/>>https://www.json.org/]].
	132	+
	133	+==== Specifications ====
	134	+
	135	+(coming soon)
	136	+
146	146	=== The openMINDS integration pipeline ===
147	147
148	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