Changelog

This page lists changes to the Risk Data Library Standard.

0.2.0 - 2023-09-08

Schema

#93 - Remove nesting in top-level object.
#101 - create Exposure object and updated associated field names, titles and descriptions.
#105 - Create Spatial object, replacing common.geo_coverage.
#102 - Replace resource object with Resource definition, add Resource.id and update the names, titles and descriptions of its other properties.
#104 - Add Period object.
#100 - Update field names, titles and descriptions not covered in other issues.
#119:
- Add fields:
  - identifier
  - sources
  - temporal_resolution
  - Resource.temporal_resolution
- Add Source definition.
- Update field descriptions in Resource definition.
- Add validation keywords to Location, Gazetteer_entry and Geometry definitions.
#116 - Replace biblio_title and biblio_url with Related_resource definition.
#115 - Add Entity and Attribution objects, update entity related field names and descriptions.
#121:
- Nest footprints within events and events within event sets.
- Update calculation_method.
- Add fields:
  - event_set.id
  - event.id
  - footprint_set.id
  - event_set.disaster_identifier
  - event_set.frequency_distribution
  - event_set.seasonality
  - event_set.calculation_method
  - event_set.number_events
  - event_set.temporal
- Add codelists for event_set.hazard_type and event_set.analysis_type.
- Move process_type from footprint_set to event and event_set.
- Create Occurrence object.
- Removes common_calc_method, common_frequency_type, common_hazard_type, common_impact_type, common_process_type and im_code.
#124:
- Replace vulnerability object with Vulnerability definition.
- Replace function_type, calculation_method, approach, f_math and f_relationship with functions object and Vulnerability_function, Fragility_function, Damage_to_loss_function and Engineering_demand_function definitions.
- Add .scale to Spatial object.
- Update field names, titles and descriptions in Vulnerability definition.
- Create Impact object and update associated field names, titles and descriptions. -#132:
- Replace loss object with Loss definition.
- Removes time_start, time_end, time_year from loss.
- Removes loss_loss_type, loss_metric from $defs.
#127 - Inline Exposure, Hazard_metadata, vulnerability, Vulnerability_function, Fragility_function, Occurence, Damage_to_loss_function, Engineering_demand_function, Probability, Empirical, Deterministic and Loss and rearrange $defs.
#168 - Add version number and links field.
#163 - fix typos within rdl_schema_0.1.json
#180 - Refactors schema, moves hazard, exposure, vulnerability and loss to top level and removes ‘anyOf’.
#181 - Various fixes:
- Codelist filename in Classification.scheme
- {{version}} placeholder replacement in built schema
- version type
- Required fields in Event_set, Hazard and Footprint
- Markdown syntax in Attribution.role description
#190 - Deletes type key from properties with $ref components.
#212 - Update top-level description.
#203, #228 - Add package schema.
#204, #229:
- Add field metrics.
- rename cost_type.csv to metric_dimension.csv and update code descriptions.
- Add quantity_kind.csv.
#207:
- update description of spatial to recommend use of bbox when coordinates based location is needed.
- update descriptions of spatial, bbox, centroid and coordinates to specify use of WGS84 and decimal degrees.
- update coordinates to allow only numbers within arrays.
#208 - Add regex pattern to coordinate_system and update description to mandate ESRI or EPSG codes.
#205 - Convert risk_data_type to array.
#215 - Remove .hazard_id, exposure_id and vulnerability_id from loss required array.
#210 - Replace resource.url with .access_url and download_url
#218 - Vulnerability·taxonomy removed from required array.
#220 - Reorder top-level fields.
#233, #235 - Rename authorNames to author_names, datePublished to date_published and gazetteerEntries to gazetteer_entries.
#232
- Convert disaster_identifiers to array of Classification objects.
- Add new codes to classification_scheme.csv.
#236, #244 - Fix broken codelist reference URLs.
#239 - Clarify purpose of links, add link to dataset identifier guidance in id description.
#241 - Update schema and documentation URLs.
#242 - Remove redundant minProperties keywords, add missing minLength and uniqueItems keywords.
#246 - Update loss component:
- Replace loss object with loss.losses array.
- Replace loss.costs array with loss.losses.cost object.

Codelists

#101 - Update and rename cost_type.csv and create exposure_category.csv.
#114 - ‘IMT.csv’ add descriptions and change pattern of codes to metric:unit.
#117 - Create ‘license.csv’ codelist and replace license_code field with license.
#105 - Create ‘country.csv’, ‘location_gazetteers.csv’ and ‘geometry_type.csv’.
#121 - Create ‘frequency_distribution.csv’ and ‘seasonality.csv’
#130 - ‘hazard_type.csv’ add descriptions and hazard category which aligns with UNDRR Hazard taxonomy, and update codes from abbreviations to human-readable words.
#134 - ‘risk_data_type.csv’, replace codes with lower-case versions.
#143 - Update ‘license.csv’ to include Open Definition conformant licences and those listed as options on WB Data Catalog.
#164 - replace camelCase codes with snake_case codes in ‘frequency_distribution.csv’ and ‘seasonality.csv’
#189 - add ‘ISO 3166-1 alpha-3’ to ‘location_gazetteers.csv and ‘generalized_extreme_value’ to ‘frequency_distribution.csv’
#136- add description for secondary_rupture.
#214 - use consistent separators in classification_scheme.csv codes.

Normative documentation

#120:
- Rename data model documentation to reference documentation.
- Use jsonschema Sphinx directive to generate schema reference tables from schema.
- Restructure reference documentation.
- Update manage.py pre-commmit to generate sub-schema reference.
#169 - Uncollapse event_sets in hazard reference table.
#146 - Update introduction to the RDLS reference section.
#193 - Fix lists of referencing fields for subschemas and codelists.
#212 - Update diagrams, add descriptions for dataset, resource and risk components.
#225 - Update high level descriptions of the 4 risk data components.
#196 - Add examples to schema reference documentation.
#214 - Improve display of codelist reference.

Non-normative documentation

#111 - Add Global Library for Schools Infrastructure (GLOSI) to taxonomies.
#171 - Updating glossary to add loss components, adjust other entries and remove images from glossary.
#174 - Add local tests guidance to developer_docs.md
#172 - Re-write use cases as user stories, for data publisher and data user roles.
#175 - Restructure documentation, rewrite landing page, add new introductory content.
#224 - Update contact email addresses.
#239 - Add content to docs/guides/metadata.md, add UNDRR-ISC HIP taxonomy mapping.
#243 - Add link to RDLS Convertor tool in navigation menu.