Json schema does not specify any mandatory fields

[MGlauer]

I noticed that the json-schema does not specify any field as required despite json schema supporting such information. This is already inconsistent with how OMI and other tools implement this specification - e.g. id is often required. There are also probably some mandatory fields in resources as discussed in OMI

This is probably something that should be changed to make tools more consistent.

[MGlauer]

@christian-rli This issue is still there. Are there plans to fix this?

[Ludee]

This will be considered in the next minor version.

[Ludee]

Is this done in the open PR? https://github.com/OpenEnergyPlatform/oemetadata/pull/43

[jh-RLI]

@Ludee @wingechr @christian-rli I think the issue is not solved with #43. We should determine which fields are considered required e.g. by omi and then mark them accordingly in schema.json.

[jh-RLI]

@Ludee Do we want to add this to v1.5.1? If so, we would need to work out a definition of which fields are mandatory.

[Ludee]

Yes, that would be great. I would go with a bare minimum:

• name
• title
• description
• contributors

[Ludee]

This issue will be solved by the new badge system developed by @steull All fields from the iron badge must be mandatory! Please link and document here.

[jh-RLI]

We can add the mandatory fields from the bages via the required keyword to the json schema https://json-schema.org/understanding-json-schema/reference/object.html#required-properties

[steull]

Here is an overview of all mandatory fields:

name resources - name resources - schema - fields - name resources - schema - fields - type resources - schema - primaryKey resources - schema - foreignKeys - fields resources - schema - foreignKeys - reference - resource resources - schema - foreignKeys - reference - fields

[jh-RLI]

@Ludee I got no time to include this in the v1.5.2 release as this might trigger more updates in other repos we can do another v1.5.3 release next week if needed.