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.
[x] Replace any remaining common_ codelist definitions in $defs with CSV codelists and context-specific field titles and descriptions
Already done in other PRs
[x] Remove any unreferenced definitions from $defs
Already done in other PRs
[x] Consider whether any definitions in $defs should be in-lined (definitions that are referenced only once, do not appear in arrays, and are not expected to be reused)
I recommend in-lining the following definitions:
EDIT: @odscjen agreed and converted this list to a tickbox in order to keep track of the in-lining
But not Event_set as this is an object in an array.
[x] Exposure
[x] Hazard_metadata
[ ] Event_set
[x] Vulnerability
[x] Vulnerability_function
[x] Fragility_function
[x] Occurrence
[x] Damage_to_loss_function
[x] Engineering_demand_function
[x] Probability
[x] Empirical
[x] Deterministic
[x] Loss
This won't have any impact on the structure of RDLS metadata, but it will make the schema easier to maintain (less duplication of titles and descriptions) and the schema reference easier to generate and digest.
[x] Consider reordering the definitions in $defs in-line with their use (e.g. grouping by hazard, exposure, vulnerability and loss, higher-level before lower-level subschemas)
Once the above definitions are in-lined, I recommend the following order for the remaining definitions:
[x] Resource
[x] Entity
[x] Attribution
[x] Related_resource
[x] Source
[x] Period
[x] Location
[x] Gazetteer_entry
[x] Geometry
[x] Hazard
[x] Trigger
[x] Event
[x] Footprint
[x] Cost
[x] Impact
[x] Classification
As above, this won't impact the structure of RDLS metadata, but it will make the schema easier to interpret.
[x] Add validation keywords by running OCDS Kit's schema-strict
@odscjen please review the changes so far. Once reviewed, you can review my recommendations in the PR description for inlining and reordering definitions, and implement them if you're happy with them.
Related issues
Description
common_
codelist definitions in$defs
with CSV codelists and context-specific field titles and descriptionsAlready done in other PRs
$defs
Already done in other PRs
$defs
should be in-lined (definitions that are referenced only once, do not appear in arrays, and are not expected to be reused)I recommend in-lining the following definitions:
EDIT: @odscjen agreed and converted this list to a tickbox in order to keep track of the in-lining But not
Event_set
as this is an object in an array.Exposure
Hazard_metadata
Event_set
Vulnerability
Vulnerability_function
Fragility_function
Occurrence
Damage_to_loss_function
Engineering_demand_function
Probability
Empirical
Deterministic
Loss
This won't have any impact on the structure of RDLS metadata, but it will make the schema easier to maintain (less duplication of titles and descriptions) and the schema reference easier to generate and digest.
$defs
in-line with their use (e.g. grouping by hazard, exposure, vulnerability and loss, higher-level before lower-level subschemas)Once the above definitions are in-lined, I recommend the following order for the remaining definitions:
Resource
Entity
Attribution
Related_resource
Source
Period
Location
Gazetteer_entry
Geometry
Hazard
Trigger
Event
Footprint
Cost
Impact
Classification
As above, this won't impact the structure of RDLS metadata, but it will make the schema easier to interpret.
schema-strict
Merge checklist
./manage.py
pre-commit