search

open-sdg / sdg-build

Python package to convert SDG-related data and metadata between formats
MIT License
5 stars 23 forks source link

Add a jsonschema schema for metadata #169

Closed brockfanning closed 3 years ago

brockfanning commented 4 years ago

Internally we are using jsonschema to validate metadata, but we don't allow for a jsonschema to be used directly. We only have the OpenSDGSchema which is basically the Prose.io schema. Let's add a simple class to allow using jsonschema directly.

jwestw commented 4 years ago

I feel these json schemas will be very much related to my work with CSVW. Would like to chat about what's being generated and used here.

brockfanning commented 4 years ago

@jwestw The issue was named vaguely, but I just renamed it to clarify that it's about metadata. Right now, we rely on a schema to validate indicator metadata, but we only support one format for that schema, which is this Prose.io schema format. This choice was made because we were recommending Prose.io for editing indicators, so we already needed that file to be in the data repository - so it made sense to use it for indicator metadata validation as well. But for implementations that do not use Prose.io, it doesn't make much sense to require a Prose-specific schema format.

When it comes to CSVW then we're talking about about a data schema, which is a different concern. It's definitely something that we need to resolve soon, both for CSVW support, and for tickets like https://github.com/open-sdg/open-sdg/issues/814. We should start discussion of a data schema here in another issue, for sure.

brockfanning commented 3 years ago

I originally suggested this ticket without a clear user need, so I'll close this for now. We can reopen if this comes up again.