JSON Schemas, Validation and CI

.circleci/config.yml

@@ -35,9 +35,34 @@ jobs:
       - run:
           name: validate
           command: npm run check-markdown
+  publish_schemas:
+    working_directory: ~/stac
+    docker:
+      - image: circleci/node:12
+    steps:
+      - checkout
+      - run:
+          name: install
+          command: npm install
+      - add_ssh_keys:
+          fingerprints:
+            - "9b:0a:88:ff:12:d1:29:9a:ff:bb:72:ab:7d:81:df:59"
+      - run:
+          name: publish
+          command: npm run publish-schemas -- $CIRCLE_TAG
 workflows:
   version: 2
-  test:
+  ci:
     jobs:
       - test_examples
-      - test_docs
+      - test_docs
+      - publish_schemas:
+          requires:
+            - test_examples
+          filters:
+            tags:
+              # All (future) tags
+              only: /.+/
+            branches:
+              # Only dev branch, not PRs
+              only: dev

.circleci/publish-schemas.js

@@ -0,0 +1,40 @@
+const klaw = require('klaw-sync');
+const path = require('path');
+const fs = require('fs');
+const ghpages = require('gh-pages');
+
+function filterFn (item) {
+	const basename = path.basename(item.path);
+	return basename === '.' || basename === 'node_modules' || basename[0] !== '.';
+}
+
+let args = process.argv.slice(2);
+let tag = 'dev';
+if (args.length && args[0].trim().length > 0) {
+	tag = args[0];
+}
+
+var folder = '.';
+var jsonSchemaFolderPattern = path.sep + 'json-schema' + path.sep;
+for (let file of klaw(folder, {filter: filterFn})) {
+	if (file.path.includes(jsonSchemaFolderPattern) && path.extname(file.path) === '.json') {
+		let source = file.path;
+		let target = 'schemas' + path.sep + tag + path.sep + path.relative(folder, file.path);
+		fs.mkdirSync(path.dirname(target), { recursive: true });
+		fs.copyFileSync(source, target);
+		console.log(target);
+	}
+}
+
+ghpages.publish('schemas/' + tag, {
+	src: '**',
+	dest: tag,
+	message: 'Publish JSON Schemas [ci skip]',
+	user: {
+	  name: 'STAC CI',
+	  email: '[email protected]'
+	}
+}, error => {
+	console.error(error ? error : 'Deployed to gh-pages');
+	process.exit(error ? 1 : 0);
+});

.gitignore

@@ -64,3 +64,6 @@ typings/
 # IntelliJ IDEA files
 .idea/
 *.iml
+
+# Folder created when CI puhlishes JSON Schemas
+schemas/

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Multiple extents (bounding boxes / intervals) are allowed per Collection
 
 ### Removed
+- Validation instructions
 
 ### Fixed
 - Fixed several JSON Schemas

README.md

@@ -45,7 +45,7 @@ the specification takes place in the [issue tracker](https://github.com/radiante
 
 ## In this Repository
 
-This repository contains the core specifications plus examples and validation schemas and tools. Also included are a
+This repository contains the core specifications plus examples and validation schemas. Also included are a
 few documents that provide more context and plans for the evolution of the specification. Each spec folder contains a
 README explaining the layout of the folder, the main specification document, examples, and validating schemas. And 
 there is one more specification in the STAC 'family', which is

catalog-spec/README.md

@@ -26,10 +26,6 @@ contains a full sample catalog.
 **Schemas:** The schemas to validate the core Catalog definition are found in the *[json-schema/](json-schema/)* folder.
 The primary one is *[catalog.json](json-schema/catalog.json)*.
 
-## Schema Validation
-
-Instruction on schema validation for STAC Catalog can be found in the [validation instructions](../validation/README.md).
-
 ## Catalog Evolution 
 
 The Catalog specification is maturing, but it is still relatively early days. The core of Catalog has been defined very

catalog-spec/json-schema/catalog.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "catalog.json#",
+  "$id": "https://schemas.stacspec.org/dev/catalog-spec/json-schema/catalog.json#",
   "title": "STAC Catalog Specification",
   "description": "This object represents Catalogs in a SpatioTemporal Asset Catalog.",
   "allOf": [

collection-spec/README.md

@@ -25,10 +25,6 @@ structures and fields.
 **Schemas:** The schemas to validate the STAC Collection definition are found in the 
 *[json-schema/](json-schema/)* folder. The primary one is *[collection.json](json-schema/collection.json)*.
 
-## Schema Validation
-
-Instruction on schema validation for STAC Items can be found in the [validation instructions](../validation/README.md).
-
 ## Collection Flexibility
 
 STAC Collections are defined for flexibility. They only require a handful of fields, and

collection-spec/collection-spec.md

@@ -11,7 +11,7 @@ STAC Collections are meant to be compatible with *OGC API - Features* Collection
 * [Examples](examples/):
   * Sentinel 2: A basic standalone example of a [Collection](examples/sentinel2.json) without items.
   * Landsat 8: A [Collection](examples/landsat-collection.json) with corresponding Item [Item](../item-spec/examples/landsat8-sample.json).
-* [JSON Schema](json-schema/collection.json) - please see the [validation instructions](../validation/README.md)
+* [JSON Schema](json-schema/collection.json)
 
 ## Collection fields
 

collection-spec/json-schema/collection.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "collection.json#",
+  "$id": "https://schemas.stacspec.org/dev/collection-spec/json-schema/collection.json#",
   "title": "STAC Collection Specification",
   "description": "This object represents Collections in a SpatioTemporal Asset Catalog.",
   "allOf": [

extensions/checksum/json-schema/schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "schema.json#",
+  "$id": "https://schemas.stacspec.org/dev/extensions/checksum/json-schema/schema.json#",
   "title": "Checksum Extension Specification",
   "description": "STAC Checksum Extension to a STAC Item",
   "oneOf": [
@@ -60,7 +60,10 @@
         "stac_extensions": {
           "type": "array",
           "contains": {
-            "const": "checksum"
+            "enum": [
+              "checksum",
+              "https://schemas.stacspec.org/dev/extensions/checksum/json-schema/schema.json"
+            ]
           }
         }
       }

extensions/collection-assets/json-schema/schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "schema.json#",
+  "$id": "https://schemas.stacspec.org/dev/extensions/collection-assets/json-schema/schema.json#",
   "title": "Collection Assets Extension Specification",
   "description": "STAC Collection-level assets Extension to a STAC Collection",
   "allOf": [
@@ -17,7 +17,10 @@
         "stac_extensions": {
           "type": "array",
           "contains": {
-            "const": "collection-assets"
+            "enum": [
+              "collection-assets",
+              "https://schemas.stacspec.org/dev/extensions/collection-assets/json-schema/schema.json"
+            ]
           }
         },
         "assets": {

extensions/datacube/json-schema/schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "schema.json#",
+  "$id": "https://schemas.stacspec.org/dev/extensions/datacube/json-schema/schema.json#",
   "title": "Data Cube Extension",
   "description": "STAC Data Cube Extension to STAC Items and STAC Collections",
   "oneOf": [
@@ -49,7 +49,10 @@
         "stac_extensions": {
           "type": "array",
           "contains": {
-            "const": "datacube"
+            "enum": [
+              "datacube",
+              "https://schemas.stacspec.org/dev/extensions/datacube/json-schema/schema.json"
+            ]
           }
         }
       }

extensions/eo/json-schema/schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "schema.json#",
+  "$id": "https://schemas.stacspec.org/dev/extensions/eo/json-schema/schema.json#",
   "title": "EO Extension",
   "description": "STAC EO Extension to a STAC Item.",
   "allOf": [
@@ -23,7 +23,10 @@
         "stac_extensions": {
           "type": "array",
           "contains": {
-            "const": "eo"
+            "enum": [
+              "eo",
+              "https://schemas.stacspec.org/dev/extensions/eo/json-schema/schema.json"
+            ]
           }
         },
         "properties": {

extensions/item-assets/json-schema/schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "schema.json#",
+  "$id": "https://schemas.stacspec.org/dev/extensions/item-assets/json-schema/schema.json#",
   "title": "Asset Definition Extension Specification",
   "description": "STAC Asset Definition Extension to a STAC Collection",
   "allOf": [
@@ -23,7 +23,10 @@
         "stac_extensions": {
           "type": "array",
           "contains": {
-            "const": "item-assets"
+            "enum": [
+              "item-assets",
+              "https://schemas.stacspec.org/dev/extensions/item-assets/json-schema/schema.json"
+            ]
           }
         },
         "item_assets": {

extensions/label/json-schema/schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "schema.json#",
+  "$id": "https://schemas.stacspec.org/dev/extensions/label/json-schema/schema.json#",
   "title": "Label Extension",
   "description": "STAC Label Data Item Extension Spec",
   "allOf": [
@@ -22,7 +22,10 @@
         "stac_extensions": {
           "type": "array",
           "contains": {
-            "const": "label"
+            "enum": [
+              "label",
+              "https://schemas.stacspec.org/dev/extensions/label/json-schema/schema.json"
+            ]
           }
         },
         "properties": {

extensions/projection/json-schema/schema.json

@@ -1,6 +1,6 @@
 {
   "$schema":"http://json-schema.org/draft-07/schema#",
-  "$id":"schema.json#",
+  "$id":"https://schemas.stacspec.org/dev/extensions/projection/json-schema/schema.json#",
   "title":"Projection Extension",
   "description":"STAC Projection Extension to a STAC Item",
   "allOf":[
@@ -22,7 +22,10 @@
         "stac_extensions": {
           "type": "array",
           "contains": {
-            "const": "projection"
+            "enum": [
+              "projection",
+              "https://schemas.stacspec.org/dev/extensions/projection/json-schema/schema.json"
+            ]
           }
         },
         "properties":{

extensions/sar/json-schema/schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "schema.json#",
+  "$id": "https://schemas.stacspec.org/dev/extensions/sar/json-schema/schema.json#",
   "title": "SAR Extension",
   "description": "STAC SAR Extension to a STAC Item",
   "allOf": [
@@ -23,7 +23,10 @@
         "stac_extensions": {
           "type": "array",
           "contains": {
-            "const": "sar"
+            "enum": [
+              "sar",
+              "https://schemas.stacspec.org/dev/extensions/sar/json-schema/schema.json"
+            ]
           }
         },
         "properties": {

extensions/sat/json-schema/schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "schema.json#",
+  "$id": "https://schemas.stacspec.org/dev/extensions/sat/json-schema/schema.json#",
   "title": "Sat Extension",
   "description": "STAC Sat Extension to a STAC Item.",
   "allOf": [
@@ -25,7 +25,10 @@
         "stac_extensions": {
           "type": "array",
           "contains": {
-            "const": "sat"
+            "enum": [
+              "sat",
+              "https://schemas.stacspec.org/dev/extensions/sat/json-schema/schema.json"
+            ]
           }
         },
         "properties": {

extensions/scientific/json-schema/schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "schema.json#",
+  "$id": "https://stacspec.org/schemas/v1.0.0-beta.1/extensions/scientific/json-schema/schema.json#",
   "title": "Scientific Extension",
   "description": "STAC Scientific Extension to STAC Items or STAC Collections.",
   "oneOf": [
@@ -49,7 +49,10 @@
         "stac_extensions": {
           "type": "array",
           "contains": {
-            "const": "scientific"
+            "enum": [
+              "scientific",
+              "https://schemas.stacspec.org/dev/extensions/scientific/json-schema/schema.json"
+            ]
           }
         }
       }

extensions/single-file-stac/json-schema/schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "schema.json#",
+  "$id": "https://schemas.stacspec.org/dev/extensions/single-file-stac/json-schema/schema.json#",
   "title": "Single File STAC Extension",
   "description": "Single File STAC Extension to combine Collections and Items in single file catalog",
   "allOf": [
@@ -25,7 +25,10 @@
         "stac_extensions": {
           "type": "array",
           "contains": {
-            "const": "single-file-stac"
+            "enum": [
+              "single-file-stac",
+              "https://schemas.stacspec.org/dev/extensions/single-file-stac/json-schema/schema.json"
+            ]
           }
         },
         "collections": {

extensions/tiled-assets/json-schema/schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "stac-extension-tiled-assets.json#",
+  "$id": "https://schemas.stacspec.org/dev/extensions/tiled-assets/json-schema/schema.json#",
   "title": "Tiled Assets Extension",
   "description": "Tiled Assets Extension to a STAC Item",
   "oneOf": [
@@ -52,7 +52,10 @@
         "stac_extensions": {
           "type": "array",
           "contains": {
-            "const": "tiled-assets"
+            "enum": [
+              "tiled-assets",
+              "https://schemas.stacspec.org/dev/extensions/tiled-assets/json-schema/schema.json"
+            ]
           }
         }
       }