Summary

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

Details

Page properties

Content

...	...	@@ -68,7 +68,7 @@
68	68	"label": "«HUMAN-READABLE_LABEL»",
69	69	"name": "«SCHEMA_NAME»",
70	70	"schemas": [
71		- "«METADATA_MODEL_LABEL»/«VERSION_BRANCH»/«SCHEMA_NAME»"
	71	+ "«RELATIVE_PATH_TO_SCHEMA_FILE_OF_THAT_TYPE»"
72	72	],
73	73	"translatableTo": [
74	74	"«REFERENCE_TO_RELATED_SCHEMA_OF_OTHER_INITIATIVE»"
...	...	@@ -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 **##"name"##** and **##"label"##** automatically derived from the respective schema type. 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" 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:
...	...	@@ -85,15 +85,16 @@
85	85
86	86	{{code language="json"}}
87	87	{
88		- "https://openminds.ebrains.eu/vocab/«PROPERTY_NAME": {
89		- "description": "GENERAL_DESCRIPTION",
90		- "name": "DISPLAY_LABEL",
91		- "nameForReverseLink": "DISPLAY_LABEL_OF_REVERSED_LINK",
	88	+ "https://openminds.ebrains.eu/vocab/«PROPERTY_NAME»": {
	89	+ "description": "«GENERAL_DESCRIPTION",
	90	+ "label": "«HUMAN-READABLE_LABEL",
	91	+ "labelForReverseLink": "«HUMAN-READABLE_LABEL_OF_REVERSED_LINK",
	92	+ "name": "«PROPERTY_NAME»",
92	92	"sameAs": [
93		- "REFERENCE_TO_MATCHING_SCHEMA-PROPERTY_OF_OTHER_INITIATIVE"
	94	+ "«REFERENCE_TO_MATCHING_SCHEMA-PROPERTY_OF_OTHER_INITIATIVE"
94	94	],
95	95	"schemas": [
96		- "RELATIVE_PATH_TO_OPENMINDS-SCHEMA_USING_THIS_PROPERTY"
	97	+ "«RELATIVE_PATH_TO_SCHEMA_FILE_CONTAINING_THIS_PROPERTY»"
97	97	]
98	98	}
99	99	}
...	...	@@ -100,7 +100,7 @@
100	100	{{/code}}
101	101
102	102	(% style="text-align: justify;" %)
103		-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 display label and list of schemas in which this property occurs automatically derived. The remaining attributes are initially provided with a null value. Once an entry for a property is made in the **##properties.json##** file, the values of all attributes (**##"name"##**, **##"description"##**, **##"nameForReversedLink"##**, and **##"sameAs"##**) can be manually edited, except for **##"schemas"##** which will be always automatically updated. All those 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.
104	104
105	105	=== The openMINDS syntax ===
106	106
...	...	@@ -123,6 +123,7 @@
123	123	"PROPERTY_NAME": {
124	124	"type": "DATA_TYPE",
125	125	"_instruction": "METADATA_ENTRY_INSTRUCTION"
	127	+ }
126	126	},
127	127	"required": [
128	128	"PROPERTY_NAME"
...	...	@@ -161,8 +161,42 @@
161	161	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"##**.
162	162
163	163	(% style="text-align: justify;" %)
164		-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 an abstract example for all possible string constraints:
165	165
	168	+{{code language="json"}}
	169	+{
	170	+ "_type": "https://openminds.ebrains.eu/LABEL_OF_METADATA_MODEL/SCHEMA_NAME",
	171	+ "properties": {
	172	+ "stringProperty_noConstraints": {
	173	+ "type": "string",
	174	+ "_instruction": "Enter a free text."
	175	+ },
	176	+ "stringProperty_lengthConstraints": {
	177	+ "maxLength": 6,
	178	+ "minLength": 2,
	179	+ "type": "string",
	180	+ "_instruction": "Enter a free text (allowed numbers of characters: 2 - 6)."
	181	+ },
	182	+ "stringProperty_formatConstraints": {
	183	+ "type": "string",
	184	+ "_formats": [
	185	+ "email",
	186	+ "date",
	187	+ "time",
	188	+ "date-time",
	189	+ "iri"
	190	+ ]
	191	+ "_instruction": "Enter a string matching one of the given formats."
	192	+ },
	193	+ "stringProperty_patternConstraints": {
	194	+ "pattern": "«regular_expression»"
	195	+ "type": "string",
	196	+ "_instruction": "Enter a string matching the given regex pattern (ECMA 262 dialect)."
	197	+ }
	198	+ }
	199	+}
	200	+{{/code}}
	201	+
166	166	=== The openMINDS integration pipeline ===
167	167
168	168	(//**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