Changes for page Technical details

Last modified by lzehl on 2021/07/05 18:57
From version 84.1
edited by lzehl
on 2021/07/05 13:26
Change comment: There is no comment for this version
To version 86.2
edited by lzehl
on 2021/07/05 15:01
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -78,7 +78,7 @@
78 78  {{/code}}
79 79  
80 80  (% style="text-align: justify;" %)
81 -With each new schema committed to one of the openMINDS metadata models, a new entry is appended to the **##types.json##** file, with the values for **##"name"##**, **##"label"##**, and **##"schemas"##** automatically derived. The remaining attributes are predefined with a null value and frequently, manually edited by a corresponding expert of the openMINDS development team. If necessary the auto-derived "label" value can be edited as well. All manual editions will be preserved and not overwritten when the file is updated again with a new commit. In case a schema is deleted from the openMINDS metadata models, the corresponding entry in the **##types.json##** file is marked as being deprecated (additional attribute-value pair; **##"deprecated": true##**). It only can be permanently removed from the **##types.json##** file, if the entry is manually deleted.
81 +With each new schema committed to one of the openMINDS metadata models, a new entry is appended to the **##types.json##** file, with the values for **##"name"##**, **##"label"##**, and **##"schemas"##** automatically derived. The remaining attributes are predefined with a null value and frequently, manually edited by a corresponding expert of the openMINDS development team. If necessary the auto-derived **##"label"##** value can be edited as well. All manual editions will be preserved and not overwritten when the file is updated again with a new commit. In case a schema is deleted from the openMINDS metadata models, the corresponding entry in the **##types.json##** file is marked as being deprecated (additional attribute-value pair; **##"deprecated": true##**). It only can be permanently removed from the **##types.json##** file, if the entry is manually deleted.
82 82  
83 83  (% style="text-align: justify;" %)
84 84  Similar to the **##types.json##** file, the **##properties.json##** file is an associative array listing all properties across all existing openMINDS schemas. For each openMINDS property, a small list of general attributes are provided in a nested associative array. Currently, the following attributes are captured:
... ... @@ -101,7 +101,7 @@
101 101  {{/code}}
102 102  
103 103  (% style="text-align: justify;" %)
104 -With each new property committed to a schema of one of the openMINDS metadata models, a new entry is appended to the **##properties.json##** file, with the **##"name"##**, **##"label"##** and **##"labelForReversedLink"##** automatically derived. The remaining attributes are predefined with a null value and frequently, manually edited by a corresponding expert of the openMINDS development team. If necessary the auto-derived values for "label" and **##"labelForReversedLink"##** can be edited as well. All manual editions will be preserved and not overwritten when the file is updated again with a new commit. In case a property is not used anymore in any of the schemas from the openMINDS metadata models, the corresponding entry in the **##properties.json##** file is marked as being deprecated (additional attribute-value pair; **##"deprecated": true##**). It only can be permanently removed from the **##properties.json##** file, if the entry is manually deleted.
104 +With each new property committed to a schema of one of the openMINDS metadata models, a new entry is appended to the **##properties.json##** file, with the **##"name"##**, **##"label"##** and **##"labelForReversedLink"##** automatically derived. The remaining attributes are predefined with a null value and frequently, manually edited by a corresponding expert of the openMINDS development team. If necessary the auto-derived values for **##"label"##** and **##"labelForReversedLink"##** can be edited as well. All manual editions will be preserved and not overwritten when the file is updated again with a new commit. In case a property is not used anymore in any of the schemas from the openMINDS metadata models, the corresponding entry in the **##properties.json##** file is marked as being deprecated (additional attribute-value pair; **##"deprecated": true##**). It only can be permanently removed from the **##properties.json##** file, if the entry is manually deleted.
105 105  
106 106  === The openMINDS syntax ===
107 107  
... ... @@ -124,6 +124,7 @@
124 124   "PROPERTY_NAME": {
125 125   "type": "DATA_TYPE",
126 126   "_instruction": "METADATA_ENTRY_INSTRUCTION"
127 + }
127 127   },
128 128   "required": [
129 129   "PROPERTY_NAME"
... ... @@ -159,11 +159,61 @@
159 159  ==== Data type depending constraints ====
160 160  
161 161  (% style="text-align: justify;" %)
162 -Depending on the expected data **##"type"##** additional constraints can be made for the metadata entry of a respective property. Currently, the openMINDS schema template syntax supports the following data types: **##"string"##**, ##**"integer"**##, **##"float"##**, **##"boolean"##**, **##"array"##** and **##"object"##**.
163 +Depending on the expected data **##"type"##** additional constraints can be made for the metadata entry of a respective property. Currently, the openMINDS schema template syntax supports the following data types: **##"string"##**, **##"number"##** (integer or float), ##**"integer"**##, **##"float"##**, **##"boolean"##**, **##"array"##** and **##"object"##**.
163 163  
164 164  (% style="text-align: justify;" %)
165 -If the expected data **##"type"##** is a **##"string"##** the expected number of characters, the format or a regular expression pattern of the string can be further defined.
166 +If the expected data **##"type"##** is a **##"string"##** the expected number of characters, the format or a regular expression pattern of the string can be further defined. Here abstract examples for all possible string constraints:
166 166  
168 +{{code language="json"}}
169 +{
170 + "properties": {
171 + "stringProperty_noConstraints": {
172 + "type": "string",
173 + "_instruction": "Enter a free text."
174 + },
175 + "stringProperty_lengthConstraints": {
176 + "maxLength": 6,
177 + "minLength": 2,
178 + "type": "string",
179 + "_instruction": "Enter a free text (allowed numbers of characters: 2 - 6)."
180 + },
181 + "stringProperty_formatConstraints": {
182 + "type": "string",
183 + "_formats": [
184 + "email",
185 + "date",
186 + "time",
187 + "date-time",
188 + "iri"
189 + ]
190 + "_instruction": "Enter a string matching one of the given formats."
191 + },
192 + "stringProperty_patternConstraints": {
193 + "pattern": "«regular_expression»"
194 + "type": "string",
195 + "_instruction": "Enter a string matching the given regex pattern (ECMA 262 dialect)."
196 + }
197 + }
198 +}
199 +{{/code}}
200 +
201 +(% class="wikigeneratedid" %)
202 +If the expected data **##"type"##** is an **##"integer"##** or a **##"number"##** (float or integer) the expected range or multiples can be further defined. Here abstract examples for all possible  **##"integer"##** and **##"number"##** constraints:
203 +
204 +{{code language="json"}}
205 +{
206 + "properties": {
207 + "numberProperty_noConstraints": {
208 + "type": "number",
209 + "_instruction": "Enter a number (float or integer)."
210 + }
211 + }
212 +}
213 +{{/code}}
214 +
215 +(% class="wikigeneratedid" %)
216 +If ...
217 +
167 167  === The openMINDS integration pipeline ===
168 168  
169 169  (//**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
Public

openMINDS