HumanBrainProject / openMINDS

openMINDS comprises a set of metadata models for research products in the field of neuroscience.
MIT License
40 stars 13 forks source link

Update properties.json (descriptions + labels + reversed labels) #36

Closed lzehl closed 1 year ago

lzehl commented 1 year ago

I will gradually update all descriptions + labels + reversed labels for all properties.

lzehl commented 1 year ago

@olinux we need to discuss the build of the properties and types again and how they should look like. Going through the properties I have the feeling that the build is inconsistent. The files (properties and types) are also getting quite large. I wonder if we should rather follow the approach of individual files per type and property. What do you think?

lzehl commented 1 year ago

schematic instance for property (we could actually define this as schema in main):

{
  "https://openminds.ebrains.eu/vocab/PROPERTY_NAME": {
      "deprecated": false,
      "description": "DEFINITION_OF_PROPERTY_NAME",
      "label": "PROPERTY_DISPLAY_LABEL",
      "labelForReverseLink": "PROPERTY_DISPLAY_LABEL_REVERSED",
      "name": "PROPERTY_NAME",
      "sameAs": [
          "REFERENCE_TO_EXTERNAL_DEFINED_PROPERTY"
      ],
      "schemas": [
          "SCHEMA_WHERE_PROPERTY_OCCURS"
      ]
  }
}

Questions:

  1. required fields: "label", "name", "schemas", "deprecated" (automated information) or ALL ?
  2. optional fields: "sameAs", "description", "labelForReverseLink" (manually added information) or NONE ?
  3. if a value is not available property should be set to "null" ?
  4. "label" should be capitalized or not ? (I prefer not to capitalize it)
  5. how should we deal with deprecated properties ? (delete or maintain and make references to new property if there was a name change between versions?)