[Schema] Minor and structural updates

GFDRR / rdl-standard

The Risk Data Library Standard (RDLS) is an open data standard to make it easier to work with disaster and climate risk data. It provides a common description of the data used and produced in risk assessments, including hazard, exposure, vulnerability, and modelled loss, or impact, data.

https://docs.riskdatalibrary.org/

Creative Commons Attribution Share Alike 4.0 International

13 stars 1 forks source link

[Schema] Minor and structural updates #94

Closed odscrachel closed 1 year ago

odscrachel commented 1 year ago

There are a number of updates that need to be made to the schema to make it valid and to capture the minor changes in the spreadsheet. These minor changes will be captured in the changelog.

Changes include, but are not limited to:

[x] Changing definitions to $defs to match current JSON schema version
[x] Add missing definitions to fix errors
[x] Update field names and descriptions where indicated in the spreadsheet
[x] Update codelists
[x] Update which fields are 'required'
[x] Check integers are replaced with supported number type
[x] Remove defs that are no longer referenced
[x] Capital formatting in defs

duncandewhurst commented 1 year ago

[ ] Add missing definitions to fix errors

https://github.com/GFDRR/rdl-standard/pull/109 adds empty definitions in order to make the schema valid.

duncandewhurst commented 1 year ago

[ ] Update field names and descriptions where indicated in the spreadsheet

https://github.com/GFDRR/rdl-standard/pull/109 adds a test to make sure that definitions and properties have titles and descriptions. Presently, many titles and descriptions are missing so the test is commented out. We should enable the test when we go through add titles and descriptions from the spreadsheet to make sure that we don't miss any.

odscjen commented 1 year ago

Also include

[x] removal of fields as agreed in this spreadsheet

odscjen commented 1 year ago

I've updated the fields and descriptions spreadsheet to note which issues relate to which fields in the original schema. This should hopefully help us ensure we're covering everything that should be covered by this minor changes update

duncandewhurst commented 1 year ago

[ ] Update field names and descriptions where indicated in the spreadsheet

109 adds a test to make sure that definitions and properties have titles and descriptions. Presently, many titles and descriptions are missing so the test is commented out. We should enable the test when we go through add titles and descriptions from the spreadsheet to make sure that we don't miss any.

I've created a (draft) PR to enable the test: https://github.com/GFDRR/rdl-standard/pull/128