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

Adding references to related schemas & schema properties of other initiatives #23

Open lzehl opened 3 years ago

lzehl commented 3 years ago

Located under the folder vocab in the main openMINDS GitHub directory, the openMINDS vocabulary is semi-automatically gathered and stored in dedicated JSON files (types.json and properties.json). The openMINDS integration pipeline makes sure that both files are updated with each commit to any of the GitHub repositories for the openMINDS metadata models. With that, the openMINDS vocab reflects always an up-to-date status of the general attributes of existing schemas and properties across all openMINDS metadata models, while providing the opportunity to centrally review and maintain their consistency. In addition, this design allows us to centrally define and maintain multiple references to related schemas and matching schema properties of other metadata initiatives.

These references to related schemas (in types.json) and matching schema properties (in properties.json) of other metadata initiatives need to be added manually.

Example for types.json:

{
    ...,
    "https://openminds.ebrains.eu/core/Person": {
        "description": "Structured information on a person.",
        "label": "Person",
        "schemas": [
            "core/v0/actors/person",
            "core/v3/actors/person"
        ],
        "translatableTo": [
            "https://schema.org/Person"
        ]
    },
    ...
}

Example for properties.json:

{
    ...,
    "https://openminds.ebrains.eu/vocab/familyName": {
        "description": "Name borne in common by members of a family.",
        "label": "Family name",
        "labelForReverseLink": "Is family name of",
        "name": "familyName",
        "sameAs": [
            "https://schema.org/familyName"
        ],
        "schemas": [
            "core/v0/actors/person",
            "core/v3/actors/person"
        ]
    },
    ...
}

Note: a schema or a schema property can have multiple reference to different related schemas or matching schema properties of different initiatives (e.g. schema.org, DataCite, etc).

@visakhmr could you take this issue over?

UlrikeS91 commented 3 years ago

@lzehl, we need to handle this as soon as possible (as discussed already anyway).