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

Specify which fields can contain markdown #33

Open olinux opened 2 years ago

olinux commented 2 years ago

We encountered markdown syntax in some of the "controlled terms" - however, the description of those properties (e.g. "description") in the schema doesn't tell anything about it. From a consumer (and validation) perspective, it would be nice to flag those fields which are containing a specific syntax.

lzehl commented 2 years ago

@olinux in principle we could assume for all strings markdown syntax, no?

lzehl commented 2 years ago

based on our in person discussion we indeed go with the option "_syntax": "markdown" for string values. that way the schema validator will ignore the definition but interpreters such as the KG can use it as a controlled statement for fields that should be interpreted via markdown

lzehl commented 2 years ago

I'll prepare the PR for the respective schemas and let you know when to update the pipeline