Merge pull request #407 from GFDRR/360-spatial-temporal

Spatial and temporal updates

Author: duncandewhurst

docs/about/changelog.md

@@ -29,6 +29,10 @@ This page lists changes to the Risk Data Library Standard.
   - Rename `Source.component` to `Source.used_in`
   - Add `.lineage.description`
   - Remove `.hazard_id`, `.exposure_id` and `.vulnerability_id` from `Losses`
+- [#407](https://github.com/GFDRR/rdl-standard/pull/407)
+  - Add `temporal` and `spatial_resolution` at dataset level
+  - Add `spatial` to `Resource`
+  - Update descriptions for `spatial`, `temporal`, `spatial_resolution` and `temporal_resolution` at both dataset and resource level.
 - [#406](https://github.com/GFDRR/rdl-standard/pull/406) - Remove fields:
   - `Event.footprint`
   - `Event_set.temporal`

docs/reference/schema.md

@@ -81,7 +81,7 @@ The following table lists all dataset-level fields:
 ```{jsonschema} ../../docs/_readthedocs/html/rdls_schema.json
 ---
 collapse: 
-  publisher,spatial,resources,referenced_by,contact_point,creator,attributions,links,hazard,exposure,vulnerability,loss
+  publisher,spatial,temporal,spatial_resolution,resources,referenced_by,contact_point,creator,attributions,links,hazard,exposure,vulnerability,loss
 addtargets:
 ---
 ```
@@ -103,11 +103,17 @@ The following table lists all resource-level fields:
 ```{jsonschema} ../../docs/_readthedocs/html/rdls_schema.json
 ---
 pointer: /$defs/Resource
-collapse: temporal
+collapse: temporal,spatial
 addtargets:
 ---
 ```
 
+## Spatial and temporal properties
+
+Spatial and temporal coverage and resolution should be specified at both dataset and resource level, even when they are consistent amongst a dataset's resources.
+
+If spatial or temporal coverage or resolution differ by resource, use the resource-level properties to describe the coverage and resolution of each resource, and the dataset-level properties to describe the overall coverage of the dataset. In particular, note that `spatial.gazetteer_entries` should be used to describe the overall area covered by the dataset, not each of the areas covered by the individual resources.
+
 ## Hazard metadata
 
 The `hazard` component is described as:
@@ -877,6 +883,7 @@ jsonpointer: /$defs/Period/description
 
 This sub-schema is referenced by the following properties:
 
+- [`temporal`](rdls_schema.json,,temporal)
 - [`Resource/temporal`](rdls_schema.json,/$defs/Resource,temporal)
 - [`Event/occurrence/empirical/temporal`](rdls_schema.json,/$defs/Event,occurrence/empirical/temporal)
 
@@ -903,6 +910,7 @@ jsonpointer: /$defs/Location/description
 This sub-schema is referenced by the following properties:
 
 - [`spatial`](rdls_schema.json,,spatial)
+- [`Resource/spatial`](rdls_schema.json,/$defs/Resource,spatial)
 
 Each `Location` has the following fields:
 
@@ -1211,6 +1219,9 @@ jsonpointer: /$defs/Hazard/description
 
 This sub-schema is referenced by the following properties:
 
+- [`Function/hazard_primary`](rdls_schema.json,/$defs/Function,hazard_primary)
+- [`Function/hazard_secondary`](rdls_schema.json,/$defs/Function,hazard_secondary)
+
 Each `Hazard` has the following fields:
 
 ```{jsonschema} ../../docs/_readthedocs/html/rdls_schema.json
@@ -1264,7 +1275,7 @@ Each `Function` has the following fields:
 ```{jsonschema} ../../docs/_readthedocs/html/rdls_schema.json
 ---
 pointer: /$defs/Function
-collapse: impact_measurement
+collapse: hazard_primary,hazard_secondary,impact_measurement
 addtargets:
 ---
 ```

schema/rdls_schema.json

@@ -83,13 +83,24 @@
     },
     "spatial": {
       "title": "Spatial coverage",
-      "description": "The geographical area covered by the dataset. If specified using coordinates, the use of `.bbox` is recommended over `.geometry` or `.centroid`.",
+      "description": "The geographical area covered by the dataset. If specified using coordinates, the use of `.bbox` is recommended over `.geometry` or `.centroid`. The spatial coverage of the resources belonging to a dataset may differ and may be non-contiguous. For more information, refer to [spatial and temporal properties](https://docs.riskdatalibrary.org/en/{{version}}/reference/schema/#spatial-and-temporal-properties).",
       "$ref": "#/$defs/Location"
     },
+    "spatial_resolution": {
+      "title": "Spatial resolution",
+      "type": "number",
+      "description": "The minimum spatial separation resolvable amongst this dataset's resources, measured in meters. The spatial coverage and resolution of the resources belonging to a dataset may differ, therefore the minimum spatial resolution of the dataset may not be resolvable for all resources. For more information, refer to [spatial and temporal properties](https://docs.riskdatalibrary.org/en/{{version}}/reference/schema/#spatial-and-temporal-properties).",
+      "exclusiveMinimum": 0
+    },
+    "temporal": {
+      "title": "Temporal coverage",
+      "description": "The period of time covered by the dataset. The temporal coverage of the resources belonging to a dataset may differ and may be non-contiguous. For more information, refer to [spatial and temporal properties](https://docs.riskdatalibrary.org/en/{{version}}/reference/schema/#spatial-and-temporal-properties).",
+      "$ref": "#/$defs/Period"
+    },
     "temporal_resolution": {
       "title": "Temporal resolution",
       "type": "string",
-      "description": "The minimum period of time resolvable in this dataset, in ISO8601 duration format.",
+      "description": "The minimum period of time resolvable amongst this dataset's resources, in ISO8601 duration format. The temporal coverage and resolution of the resources belonging to a dataset may differ, therefore the minimum temporal resolution of the dataset may not be resolvable for all resources. For more information, refer to [spatial and temporal properties](https://docs.riskdatalibrary.org/en/{{version}}/reference/schema/#spatial-and-temporal-properties).",
       "format": "duration"
     },
     "license": {
@@ -444,10 +455,15 @@
           "openCodelist": true,
           "minLength": 1
         },
+        "spatial": {
+          "title": "Spatial coverage",
+          "description": "The geographical area covered by the resource. If specified using coordinates, the use of `.bbox` is recommended over `.geometry` or `.centroid`. For more information, refer to [spatial and temporal properties](https://docs.riskdatalibrary.org/en/{{version}}/reference/schema/#spatial-and-temporal-properties).",
+          "$ref": "#/$defs/Location"
+        },
         "spatial_resolution": {
           "title": "Spatial resolution",
           "type": "number",
-          "description": "The minimum spatial separation resolvable in this resource, measured in meters.",
+          "description": "The minimum spatial separation resolvable in this resource, measured in meters. For more information, refer to [spatial and temporal properties](https://docs.riskdatalibrary.org/en/{{version}}/reference/schema/#spatial-and-temporal-properties).",
           "exclusiveMinimum": 0
         },
         "spatial_aggregation": {
@@ -463,6 +479,17 @@
           "pattern": "^(ESRI:|EPSG:)[0-9]+$",
           "minLength": 1
         },
+        "temporal": {
+          "title": "Temporal coverage",
+          "description": "The period of time covered by this resource. For more information, refer to [spatial and temporal properties](https://docs.riskdatalibrary.org/en/{{version}}/reference/schema/#spatial-and-temporal-properties).",
+          "$ref": "#/$defs/Period"
+        },
+        "temporal_resolution": {
+          "title": "Temporal resolution",
+          "type": "string",
+          "description": "The minimum period of time resolvable in this resources, in ISO8601 duration format. For more information, refer to [spatial and temporal properties](https://docs.riskdatalibrary.org/en/{{version}}/reference/schema/#spatial-and-temporal-properties).",
+          "format": "duration"
+        },
         "access_url": {
           "title": "Access Url",
           "type": "string",
@@ -474,17 +501,6 @@
           "type": "string",
           "description": "The web address this resource can be downloaded from in the given `.format`.",
           "minLength": 1
-        },
-        "temporal": {
-          "title": "Temporal coverage",
-          "description": "The period of time covered by this resource.",
-          "$ref": "#/$defs/Period"
-        },
-        "temporal_resolution": {
-          "title": "Temporal resolution",
-          "type": "string",
-          "description": "The minimum period of time resolvable in this resource, in ISO8601 duration format.",
-          "format": "duration"
         }
       },
       "minProperties": 1