Conversion of YAML to JSON schema

OpenEthicsAI / OEDP

Open Ethics Data Passport

MIT License

2 stars 1 forks source link

Conversion of YAML to JSON schema #1

Open abhi12ravi opened 4 months ago

OpenEthicsAI commented 4 months ago

Hi, here's the general overview

Convert https://github.com/OpenEthicsAI/OEDP/tree/main/API/models to JSON schema from YAML
Follow the newest hierarchy described here https://openethics.ai/oedp/ (not yet in the YAML) to incorporate the idea that there could be multiple models supporting a product
Follow the latest meta-schema is 2020-12 from https://json-schema.org/specification
Provide descriptions of the schema elements within the schema, in collaboration with other team members

abhi12ravi commented 2 months ago

Hi @nikiluk @OpenEthicsAI I've sent in a PR towards the first task. If that's fine, I will work on the next three tasks. Looking forward to your feedback!

nikiluk commented 2 months ago

@abhi12ravi great progress. One more thing in addition to my inline comments in JSON files, I suggest we store the resulting schemas in the root folder to avoid confusion and maybe even discontinue YAML over time as JSON provides richer descriptive capabilities. Feel free to commit with the brand new structure e.g. /schema/Open Ehics Data Passport.json

abhi12ravi commented 1 month ago

@abhi12ravi great progress. One more thing in addition to my inline comments in JSON files, I suggest we store the resulting schemas in the root folder to avoid confusion and maybe even discontinue YAML over time as JSON provides richer descriptive capabilities. Feel free to commit with the brand new structure e.g. /schema/Open Ehics Data Passport.json

@nikiluk Could we have a separate issue for this request? It's a bit confusing for me.