Summary

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

Details

Page properties

Content

...	...	@@ -16,12 +16,18 @@
16	16	As stated above, openMINDS supports JSON-LD as serialization format for the metadata representations (instances) of its schemas. In the following we will briefly explain the JSON-LD syntax necessary for writing a correct openMINDS instance.
17	17
18	18	(% style="text-align: justify;" %)
19		-Let us first start with the most simple example: the openMINDS core schema ContactInformation. According to its schema template (cf. [[ContactInformation HTML>>https://humanbrainproject.github.io/openMINDS/core/schemas/v3/actors/contactInformation.html||rel="noopener noreferrer" target="_blank"]]), the only required property for a contact information instance is **##"email"##**. Nonetheless, every valid JSON-LD needs two more technical properties: **##"@type"##** and **##"@id"##**.
	19	+Let us first start with the most simple example: the openMINDS core schema ContactInformation. According to its schema template (cf. [[ContactInformation HTML>>https://humanbrainproject.github.io/openMINDS/core/schemas/v3/actors/contactInformation.html||rel="noopener noreferrer" target="_blank"]]), the only required property for a contact information instance is **##"email"##**. However, every valid JSON-LD needs two more technical properties: **##"@type"##** and **##"@id"##**.
20	20
21	21	(% style="text-align: justify;" %)
22		-To simplify the human-readability for all users, technical properties specifically required for the JSON-LD syntax are, on purpose, not defined in the openMINDS schema templates to simplify their readability. Instead, these technical properties are first added to the required property list of all openMINDS schemas after their template is transformed into a full-blown metadata schema format, such as JSON-Schema (cf. [[Technical details>>Technical details]]).
	22	+To simplify the human-readability for all openMINDS users, technical properties specifically required for the JSON-LD syntax are, on purpose, not defined in the openMINDS schema templates. Instead, these technical properties are first added to the required property list of all openMINDS schemas after their template is transformed into an established, full-blown metadata schema format, such as JSON-Schema (cf. [[Technical details>>Technical details]]).
23	23
	24	+(% style="text-align: justify;" %)
	25	+In general, the JSON-LD property **##"@type"##** expects an entry (value) of type string that defines which schema is used to validate the particular JSON-LD. Within openMINDS each schema can be identified through its namespace (type) with the following naming convention:
24	24
	27	+(% style="text-align: justify;" %)
	28	+(% class="small" %)##"https:~/~/openminds.ebrains.eu/" + <openMINDS-submodule label> + "/" + <openMINDS schema label>##
	29	+
	30	+
25	25	=== The openMINDS Python API ===
26	26
27	27	(% style="text-align: justify;" %)