Changes for page Technical details

Last modified by lzehl on 2021/07/05 18:57

From 83.1 to 83.2 From 90.1 to 91.1

From version 83.2

edited by lzehl
on 2021/07/05 13:16

Change comment: There is no comment for this version

To version 90.1

edited by lzehl
on 2021/07/05 18:56

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -68,7 +68,7 @@
      "label": "«HUMAN-READABLE_LABEL»",
      "name": "«SCHEMA_NAME»",
      "schemas": [
--      "«METADATA_MODEL_LABEL»/«VERSION_BRANCH»/«SCHEMA_NAME»"
++      "«RELATIVE_PATH_TO_SCHEMA_FILE_OF_THAT_TYPE»"
      ],
      "translatableTo": [
        "«REFERENCE_TO_RELATED_SCHEMA_OF_OTHER_INITIATIVE»"
@@ -78,7 +78,7 @@
  {{/code}}
  (% style="text-align: justify;" %)
--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.
++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.
  (% style="text-align: justify;" %)
  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 @@
  {{code language="json"}}
  {
--  "https://openminds.ebrains.eu/vocab/«PROPERTY_NAME": {
--    "description": "GENERAL_DESCRIPTION",
--    "name": "DISPLAY_LABEL",
--    "nameForReverseLink": "DISPLAY_LABEL_OF_REVERSED_LINK",
++  "https://openminds.ebrains.eu/vocab/«PROPERTY_NAME»": {
++    "description": "«GENERAL_DESCRIPTION",
++    "label": "«HUMAN-READABLE_LABEL",
++    "labelForReverseLink": "«HUMAN-READABLE_LABEL_OF_REVERSED_LINK",
++    "name": "«PROPERTY_NAME»",
      "sameAs": [
--      "REFERENCE_TO_MATCHING_SCHEMA-PROPERTY_OF_OTHER_INITIATIVE"
++      "«REFERENCE_TO_MATCHING_SCHEMA-PROPERTY_OF_OTHER_INITIATIVE"
      ],
      "schemas": [
--      "RELATIVE_PATH_TO_OPENMINDS-SCHEMA_USING_THIS_PROPERTY"
++      "«RELATIVE_PATH_TO_SCHEMA_FILE_CONTAINING_THIS_PROPERTY»"
      ]
    }
  }
@@ -100,7 +100,7 @@
  {{/code}}
  (% style="text-align: justify;" %)
--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.
++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.
  === The openMINDS syntax ===
@@ -123,6 +123,7 @@
      "PROPERTY_NAME": {
        "type": "DATA_TYPE",
        "_instruction": "METADATA_ENTRY_INSTRUCTION"
++    }
    },
    "required": [
      "PROPERTY_NAME"
@@ -137,7 +137,7 @@
  Under **##"properties"##** a nested associative array is defined, where each key defines the property name (format: lowerCamelCase; e.g. **##"givenName"##**). The corresponding value is again a nested associative array defining the expected data **##"type"##** (cf. below) and the **##"_instructions"##** for entering the correct metadata for the respective property.
  (% style="text-align: justify;" %)
--Under **##"required"##** a list of property names can be provided that are obligatory to be present in a correctly instantiated metadata instance of the respective schema. If none of the properties are required, this key-value pair does not have to be specified.
++Under **##"required"##** a list of property names can be provided that are obligatory to be present in a correctly instantiated metadata instance of the respective schema. If none of the properties are required, this key-value pair does not have to be specified. Note that within openMINDS, it is assumed that only the stated properties are allowed (additional undefined properties are prohibited per default).
  (% style="text-align: justify;" %)
  ==== Schemas extending a context-schema ====
@@ -158,11 +158,148 @@
  ==== Data type depending constraints ====
  (% style="text-align: justify;" %)
--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"##**.
++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"##**, **##"object"##** or **##"array"##**. Except for **##"boolean"##**, all these data types can have additional constraints. The essential constraints will be summarized in the following (cf. [[JSON-Schema specifications 7.0>>https://json-schema.org/understanding-json-schema/index.html||rel="noopener noreferrer" target="_blank"]] for more).
  (% style="text-align: justify;" %)
--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.
++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:
++{{code language="json"}}
++{
++  "properties": {
++    "stringProperty_noConstraints": {
++      "type": "string",
++      "_instruction": "Enter a free text."
++    },
++    "stringProperty_lengthConstraints": {
++      "maxLength": 6,
++      "minLength": 2,
++      "type": "string",
++      "_instruction": "Enter a free text (allowed numbers of characters: 2 - 6)."
++    },
++    "stringProperty_formatConstraints": {
++      "type": "string",
++      "_formats": [
++        "email",
++        "date",
++        "time",
++        "date-time",
++        "iri"
++      ]
++      "_instruction": "Enter a string matching one of the given formats."
++    },
++    "stringProperty_patternConstraints": {
++      "pattern": "«regular_expression_ECMA_262_dialect»"
++      "type": "string",
++      "_instruction": "Enter a string matching the given regex pattern."
++    }
++  }
++}
++{{/code}}
++
++(% class="wikigeneratedid" %)
++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 (not that both constraints can be defined for both data types):
++
++{{code language="json"}}
++{
++  "properties": {
++    "integerProperty_noConstraints": {
++      "type": "integer",
++      "_instruction": "Enter an integer."
++    },
++    "integerProperty_rangeConstraints": {
++      "maximum": 50,
++      "minimum": 10,
++      "type": "integer",
++      "_instruction": "Enter an integer equal or between 10 and 50."
++    },
++    "numberProperty_noConstraints": {
++      "type": "number",
++      "_instruction": "Enter a number (float or integer)."
++    },
++    "numberProperty_multipleOfConstraints": {
++      "multipleOf": 10.5,
++      "type": "number",
++      "_instruction": "Enter any number which is a multiple of 10.5."
++    }
++  }
++}
++{{/code}}
++
++(% class="wikigeneratedid" %)
++If the expected data **##"type"##** is an **##"object"##** the expected schema type needs to be defined, as well as if the object is linked or embedded. Note that linked objects can exist by themselves. In contrast embedded objects depend on the existence of their parent schema (if the parent schema is deleted, the embedded objects will be deleted as well). Here abstract examples for all possible  **##"object"##** constraints:
++
++{{code language="json"}}
++{
++  "properties": {
++    "objectProperty_linked": {
++      "_linkedTypes": [
++        "«SCHEMA_TYPE»"
++      ],
++      "_instruction": "Add the link to an instance conform with the given schema types."
++    },
++    "objectProperty_embedded": {
++      "_embeddedTypes": [
++        "«SCHEMA_TYPE»"
++      ],
++      "_instruction": "Enter an instance conform with the given schema types."
++    }
++  }
++}
++{{/code}}
++
++(% class="wikigeneratedid" %)
++If the expected data **##"type"##** is an **##"array"##** the expected data type of the items in the array, as well as the expected length of the array can be further defined. Valid data types for items are **##"string"##**, **##"number"##**, ##**"integer"**##, **##"float"##**, **##"boolean"##**, and/or **##"object"##**. In addition, items can also be defined as n-tuples with expected data types. Note that any of the above data type depending constraints can be also applied to respective items. Note that within openMINDS, it is assumed that only the stated item types are allowed (additional unconstrained items are prohibited per default). All array constraints can be applied to all item types. Here abstract examples for all possible  **##"array"##** constraints:
++
++{{code language="json"}}
++{
++  "properties": {
++    "arrayProperty_noConstraints": {
++      "type": "array",
++      "_instruction": "Add at least one item of any data type."
++    },
++    "arrayProperty_itemsOfTypeInteger": {
++      "type": "array",
++      "items": {
++        "type": "integer"
++      },
++      "_instruction": "Add at least one item of data type integer."
++    },
++    "arrayProperty_uniqueItemsOfTypeString": {
++      "type": "array",
++      "items": {
++        "type": "string"
++      },
++      "uniqueItems": true,
++      "_instruction": "Add unique items of data type string."
++    },
++    "arrayProperty_itemsOfTypeNumber_constrainedArrayLength": {
++      "type": "array",
++      "items": {
++        "type": "number"
++      },
++      "maxItems": 3,
++      "minItems": 2,
++      "_instruction": "Add 2 or 3 items of data type number."
++    },
++    "arrayProperty_objectArray": {
++      "type": "array",
++      "_linkedTypes": [
++        "«SCHEMA_TYPE»"
++      ],
++      "_instruction": "Add at least one link to an instance conform with the given schema types."
++    },
++    "arrayProperty_tuplesWithDefinedDataTypes": {
++      "type": "array",
++      "items": [
++        {"type": "string"},
++        {"type": "integer"}
++      ],
++      "_instruction": "Add at least one 2-tuple with data type string and integer."
++    }
++  }
++}
++{{/code}}
++
  === The openMINDS integration pipeline ===
  (//**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