Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update descriptions for spatial, bbox, coordinates and centroid #207

Merged
merged 12 commits into from
Aug 29, 2023
4 changes: 4 additions & 0 deletions docs/about/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ This page lists changes to the Risk Data Library Standard.
- Markdown syntax in `Attribution.role` description
- [#190](https://github.com/GFDRR/rdl-standard/pull/190) - Deletes type key from properties with `$ref` components.
- [#203](https://github.com/GFDRR/rdl-standard/pull/203) - Add package schema.
- [#207](https://github.com/GFDRR/rdl-standard/pull/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](https://github.com/GFDRR/rdl-standard/pull/208) - Add regex pattern to `coordinate_system` and update description to mandate ESRI or EPSG codes.
- [#205](https://github.com/GFDRR/rdl-standard/pull/205) - Convert `risk_data_type` to array.

Expand Down
27 changes: 22 additions & 5 deletions schema/rdls_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@
},
"spatial": {
"title": "Spatial coverage",
"description": "The geographical area covered by the dataset.",
"description": "The geographical area covered by the dataset. If specified using coordinates, the use of `.bbox` is recommended over `.geometry` or `.centroid`.",
"$ref": "#/$defs/Location"
},
"license": {
Expand Down Expand Up @@ -1392,7 +1392,7 @@
"bbox": {
"title": "Bounding box",
"type": "array",
"description": "A geographic bounding box delimiting the geographical area.",
"description": "A geographic bounding box delimiting the geographical area. This field is an array of numbers. It must contain exactly four numbers with the first two numbers being the longitude and latitude of the most southwesterly point and the second two numbers being the longitude and latitude of the most northeasterly point. Coordinates must be specified using the World Geodetic System 1984 (WGS 84) datum, with longitude and latitude units of decimal degrees. This is equivalent to the coordinate reference system identified by the Open Geospatial Consortium URN urn:ogc:def:crs:OGC::CRS84.",
"items": {
"type": "number"
},
Expand All @@ -1401,13 +1401,13 @@
},
"geometry": {
"title": "Geometry",
"description": "A set of coordinates denoting the vertices of the geographical area.",
"description": "A set of coordinates denoting the vertices of the geographical area. This field describes the extent of the geographical area. To avoid creating very large metadata, geometries should have fewer than 50 vertices.",
"$ref": "#/$defs/Geometry"
},
"centroid": {
"title": "Centroid",
"type": "array",
"description": "The coordinates of the centre of the geographical area.",
"description": "The coordinates of the centre of the geographical area. This field is an array of numbers. It must contain exactly two numbers with longitude (easting) first and latitude (northing) second. Coordinates must be specified using the World Geodetic System 1984 (WGS 84) datum, with longitude and latitude units of decimal degrees. This is equivalent to the coordinate reference system identified by the Open Geospatial Consortium URN urn:ogc:def:crs:OGC::CRS84.",
"items": {
"type": "number"
},
Expand Down Expand Up @@ -1490,12 +1490,29 @@
"coordinates": {
"title": "Coordinates",
"type": "array",
"description": "One or more GeoJSON positions according to the GeoJSON geometry type defined in `.type`.",
"description": "One or more GeoJSON positions according to the GeoJSON geometry type defined in `.type`. Each position is an array of numbers containing exactly two numbers with longitude (easting) first and latitude (northing) second. Coordinates must be specified using the World Geodetic System 1984 (WGS 84) datum, with longitude and latitude units of decimal degrees. This is equivalent to the coordinate reference system identified by the Open Geospatial Consortium URN urn:ogc:def:crs:OGC::CRS84.",
"items": {
"type": [
"number",
"array"
],
"items": {
"type": [
"number",
"array"
],
"items": {
"type": [
"number",
"array"
],
"items": {
"type": "number"
},
"minItems": 1
},
"minItems": 1
},
"minItems": 1
},
"minItems": 1
Expand Down