Merge pull request #7 from cividi/fix-json-schema

an initial json schema

Author: n0rdlicht

.github/workflows/test.yaml

@@ -0,0 +1,36 @@
+name: Validate Data Package and Schema
+
+on:
+  push:
+  pull_request:
+
+  repository_dispatch:
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: "12"
+      - name: Install data-cli
+        run: |
+          npm install
+      - name: Validate Data Package and Schema
+        shell: "bash"
+        id: validation
+        run: |
+          out=$(npm run test)
+          out="${out//'%'/'%25'}"
+          out="${out//$'\n'/'%0A'}"
+          out="${out//$'\r'/'%0D'}"
+          echo $out
+          echo "::set-output name=data-validate::$out\n"
+      - name: Check for Failure
+        if: contains(steps.validation.outputs.data-validate,'Error')
+        env:
+          OUTPUT: ${{ steps.validation.outputs.data-validate }}
+        run: |
+          echo $OUTPUT
+          exit 1

.gitignore

@@ -1 +1,2 @@
 process
+node_modules

README.md

@@ -1,15 +1,51 @@
-# Geospatial Datapackage Specification
+# (Geo) Spatial Data Package Specification
 
-This is an example Geospatial Data Package.
+This document outlines a (geo) spatial data package [profile](https://specs.frictionlessdata.io/profiles/) for [JSON-based](https://en.wikipedia.org/wiki/JSON) [Frictionless Data Packages](https://specs.frictionlessdata.io/data-package/), also called a Snapshot.
 
-This datapackage follows the [Frictionless Data Specification](https://frictionlessdata.io) and defines a way of specifying a simple map view based on geojsons as a data resource to the package.
+It follows the [Frictionless Data Specification](https://frictionlessdata.io) and provides a simple, human-readable way of defining map views with [styled](https://github.com/cividi/simplestyle-extended-spec) [GeoJSON](https://geojson.org) documents.
 
-## Datapackage Structure
+## Usage
 
-### Licenses and Sources
+### Editor Linting
+
+To add linting support to your editor (e.g. VS Code has built in support) you can check directly against the [JSON schema `schema/snapshot.json`](schema/snapshot.json).
+
+Simply add
+```json
+"$schema": "https://raw.githubusercontent.com/cividi/spatial-data-package-spec/main/schemas/snapshot.json"
+```
+to your data package and enable linting support for JSON schemas.
+
+### Validation with Frictionless Tools
+
+Make sure to include 
+```json
+"profile": "https://raw.githubusercontent.com/cividi/spatial-data-package-spec/main/schemas/snapshot.json"
+```
+in your Snapshot file. You can then use Frictionless Tools, e.g. data-cli to validate the schema and tabular data:
+```sh
+data validate . # Looks for datapackage.json in current folder
+```
+
+## Detailed Data Package Structure
+
+In addition to the basic structure of a Data Package (cf. [Frictionless Data Package](https://specs.frictionlessdata.io/data-package/)) requiring
+
+1. a `name` and
+1. a `resource`
 
-- `Licenses:` Defines the details of the licenses
-- `Sources`: Sources that have been used as input
+a Snapshots (Spatial Data Package) also require (technical details see below)
+
+1. a `view` – Defining how the map can be rendered
+1. a `source` – Listing data sources
+1. `resource`s added to a `view` to be either
+   - a simple-style GeoJSON – for Lines, Polygons, Markers
+   - a simple-style-extended GeoJSON – for Circles
+   - a mapbox style URL – for a background map
+
+### Examples
+
+A valid example can be found in [`datapackage.json`](datapackage.json).
 
 ### Resources
 
@@ -18,7 +54,7 @@ An array of resources with links to or the data itself. Includes a resource `nam
 Possible Mediatypes
 
 - `application/geo+json`: GeoJSON with [Mapbox Simple Styles](https://github.com/mapbox/simplestyle-spec)
-- `application/vnd.simplestyle-extended`: GeoJSON with [Extended Simple Styles](https://github.com/cividitech/simplestyle-extended-spec)
+- `application/vnd.simplestyle-extended`: GeoJSON with [Extended Simple Styles](https://github.com/cividi/simplestyle-extended-spec)
 - `application/vnd.mapbox-vector-tile`: Mapbox URI for styled vector tiles
 
 ### Views
@@ -31,54 +67,110 @@ For a map view compatible with the [Gemeindescan-Project](https://bitbucket.org/
 
 ```json
 {
-  "name": "mapview",
-  "resources": [
-      "geojson-resource-name-1",
-      "geojson-resource-name-2",
-      "mapbox-resource-name"
+  "name": "package-name",
+  "profile": "https://raw.githubusercontent.com/cividi/spatial-data-package-spec/main/schemas/snapshot.json",
+  "views":[
+    {
+      "name": "mapview",
+      "resources": [
+          "geojson-resource-name-1",
+          "mapbox-resource-name"
+      ],
+      "specType": "gemeindescanSnapshot",
+      "spec": {
+        "title": "Snapshot Title",
+        "description": "Snapshot Description",
+        "bounds": [
+            "geo:47.43668029143545,9.355459213256836",
+            "geo:47.483104811626674,9.424123764038086"
+        ],
+        "legend": [{
+          "label": "Legend text",
+          "shape": "square",
+          "size": 0.5,
+          "primary": true,
+          "fillColor": "#ffffff",
+          "fillOpacity": 0.2,
+          "strokeColor": "#000000",
+          "strokeOpacity": 1,
+          "strokeWidth": 1
+        }]
+      }
+    }
   ],
-  "specType": "gemeindescanSnapshot",
-  "spec": {
-    "title": "Snapshot Title",
-    "description": "Snapshot Description",
-    "bounds": [
-        "geo:47.43668029143545,9.355459213256836",
-        "geo:47.483104811626674,9.424123764038086"
-    ],
-    "legend": [{
-      "shape": "square",
-      "size": 0.5,
-      "color": "#fff",
-      "opacity": 0.2,
-      "label": "Legend text",
-      "primary": true
-    }]
-  }
+  "resources":[
+    {
+      "name": "geojson-resource-name-1",
+      "mediatype": "application/vnd.simplestyle-extended",
+      "data": {
+        "type": "FeatureCollection",
+        "features": [{
+          "type": "Feature",
+          "geometry": {
+            "type": "Point",
+            "coordinates": [9.38771, 47.46058]
+          },
+          "properties": {
+            "fid": 1,
+            "radius": 200,
+            "fillColor": "red",
+            "fillOpacity": 0.2,
+            "title": "Centerpoint",
+            "color": "red",
+            "weight": 1,
+            "opacity": 0.8
+          }
+        }]
+      }
+    },
+    {
+      "path": "mapbox://styles/gemeindescan/ckc4sha4310d21iszp8ri17u2",
+      "mediatype": "application/vnd.mapbox-vector-tile",
+      "name": "mapbox-resource-name"
+    }
+  ]
 }
 ```
 
 - `name`: name of the view (unique within datapackage)
 - `resources`: an array of resource-names (see above) in order of rendering, first will be lowest in render order
-- `specType`: currently only `map` is supported here
+- `specType`: currently only `gemeindescanSnapshot` is supported here
 - `spec`: Metainformation to render a full map view
   - `title`: Title of the View
   - `description`: Description of the View 
   - `bounds`: array of bounding box support geopoints, denoted as Geo-URI as defined by [RFC5870](https://tools.ietf.org/html/rfc5870), latitude first
   - `legend`: Legend entries for the view
+    - `label`: legend entry text
     - `shape`: one of square, circle or line
     - `size`: relative size in percent, either size of the sqaure or circle or line thickness
-    - `color`: fill/main color
-    - `opacity`: opacity value
-    - `label`: legend entry text
     - `primary`: can be used for simplifying the legend to less elements in size constraint contexts
+    - `fillColor`: fill/main color
+    - `fillOpacity`: opacity value
+    - `strokeColor`: stroke color
+    - `strokeOpacity`: stroke opacity
+    - `strokeWidth`: stroke width
+
+### Licenses and Sources
+
+- `Licenses:` *optional* Defines the details of the licenses
+- `Sources`: Sources that have been used
 
 ### Contributors and Maintainers
 
 Each represents an array of people and institutions, companies involved in creating and maintaining the datapackage. 
 
+## Unit testing
+
+To validate [`datapackage.json`](datapackage.json) against the current schema, run
+
+```sh
+npm install
+npm run test
+```
+
 ## Sample Data
 
-Data comes from open data sources via the [CIVIDI project](https://cividi.ch).
+Data comes from open data sources via the [cividi project](https://cividi.ch).
 
 ## License
 

datapackage.json

@@ -2,12 +2,9 @@
     "name": "gemeindescan-snapshot-sample",
     "title": "Gemeindescan Snapshot Sample",
     "keywords": ["europe", "switzerland", "gemeindescan", "geodata"],
-    "format": "geojson",
+    "profile": "https://raw.githubusercontent.com/cividi/spatial-data-package-spec/main/schemas/snapshot.json",
     "description": "",
-    "datapackage_version": "1.0.0",
-    "gemeindescan_version": "0.2",
-    "last_modified": "2020-02-17",
-    "version": "1.0.0",
+    "last_modified": "2021-02-20",
     "license": "ODC-By-1.0",
     "licenses": [{
         "type": "ODC-By-1.0",
@@ -17,9 +14,11 @@
         "title": "swissBOUNDARIES3D municipal boundaries",
         "url": "https://opendata.swiss/en/dataset/swissboundaries3d-gemeindegrenzen"
     }],
-    "resources": [{
+    "resources": [
+        {
             "title": "Gemeinden",
             "description": "Gemeinde und Nachbargemeinden",
+            "profile": "https://json.schemastore.org/geojson",
             "mediatype": "application/geo+json",
             "name": "gemeinden-geojson",
             "data": {
@@ -8850,6 +8849,7 @@
         }, {
             "name": "circle-layer",
             "mediatype": "application/vnd.simplestyle-extended",
+            "profile": "https://json.schemastore.org/geojson",
             "data": {
                 "type": "FeatureCollection",
                 "features": [{
@@ -8861,18 +8861,18 @@
                     "properties": {
                         "fid": 1,
                         "radius": 200,
-                        "fill": "red",
-                        "fill-opacity": 0.2,
+                        "fillColor": "red",
+                        "fillOpacity": 0.2,
                         "title": "Centerpoint",
-                        "stroke": "red",
-                        "stroke-width": 1,
-                        "stroke-opacity": 0.8
+                        "color": "red",
+                        "weight": 1,
+                        "opacity": 0.8
                     }
                 }]
             }
         },
         {
-            "path": "mapbox://styles/gemeindescan/ck6qnoijj28od1is9u1wbb3vr",
+            "path": "mapbox://styles/gemeindescan/ckc4sha4310d21iszp8ri17u2",
             "mediatype": "application/vnd.mapbox-vector-tile",
             "name": "mapbox-background"
         }
@@ -8894,20 +8894,37 @@
                     "geo:47.483104811626674,9.424123764038086"
                 ],
                 "legend": [{
+                        "label": "Square",
                         "shape": "square",
+                        "primary": false,
                         "size": 1,
-                        "color": "#32b6ca",
-                        "opacity": 1,
-                        "label": "Gemeinde",
-                        "primary": true
+                        "fillColor": "#32b6ca",
+                        "fillOpacity": 0.6,
+                        "strokeColor": "#32b6ca",
+                        "strokeOpacity": 1,
+                        "strokeWidth": 1.5
                     },
                     {
-                        "shape": "square",
+                        "label": "Circle",
+                        "shape": "circle",
+                        "primary": true,
+                        "size": 1,
+                        "fillColor": "#6a6a6a",
+                        "fillOpacity": 0.2,
+                        "strokeColor": "#6a6a6a",
+                        "strokeOpacity": 0.25,
+                        "strokeWidth": 1
+                    },
+                    {
+                        "label": "Line",
+                        "shape": "line",
+                        "primary": true,
                         "size": 1,
-                        "color": "#6a6a6a",
-                        "opacity": 1,
-                        "label": "Nachbargemeinde",
-                        "primary": true
+                        "fillColor": "#000",
+                        "fillOpacity": 0,
+                        "strokeColor": "#000000",
+                        "strokeOpacity": 1,
+                        "strokeWidth": 0.5
                     }
                 ]
             }