Move json schema #204

OpenEnergyPlatform · Nov 6, 2024 · c1ebb94 · c1ebb94
1 parent 982e291
commit c1ebb94
Show file tree

Hide file tree

Showing 7 changed files with 258 additions and 0 deletions.
diff --git a/metadata/v10/metaschema/__init__.py b/metadata/v10/metaschema/__init__.py
diff --git a/metadata/v10/metaschema/draft07/__init__.py b/metadata/v10/metaschema/draft07/__init__.py
diff --git a/metadata/v10/metaschema/draft07/schema.json b/metadata/v10/metaschema/draft07/schema.json
@@ -0,0 +1,241 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "http://json-schema.org/draft-07/schema#",
+    "title": "Core schema meta-schema",
+    "definitions": {
+        "schemaArray": {
+            "type": "array",
+            "minItems": 1,
+            "items": {
+                "$ref": "#"
+            }
+        },
+        "nonNegativeInteger": {
+            "type": "integer",
+            "minimum": 0
+        },
+        "nonNegativeIntegerDefault0": {
+            "allOf": [
+                {
+                    "$ref": "#/definitions/nonNegativeInteger"
+                },
+                {
+                    "default": 0
+                }
+            ]
+        },
+        "simpleTypes": {
+            "enum": [
+                "array",
+                "boolean",
+                "integer",
+                "null",
+                "number",
+                "object",
+                "string"
+            ]
+        },
+        "stringArray": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "uniqueItems": true,
+            "default": []
+        }
+    },
+    "type": [
+        "object",
+        "boolean"
+    ],
+    "properties": {
+        "$id": {
+            "type": "string",
+            "format": "uri-reference"
+        },
+        "$schema": {
+            "type": "string",
+            "format": "uri"
+        },
+        "$ref": {
+            "type": "string",
+            "format": "uri-reference"
+        },
+        "$comment": {
+            "type": "string"
+        },
+        "title": {
+            "type": "string"
+        },
+        "description": {
+            "type": "string"
+        },
+        "default": true,
+        "readOnly": {
+            "type": "boolean",
+            "default": false
+        },
+        "examples": {
+            "type": "array",
+            "items": true
+        },
+        "multipleOf": {
+            "type": "number",
+            "exclusiveMinimum": 0
+        },
+        "maximum": {
+            "type": "number"
+        },
+        "exclusiveMaximum": {
+            "type": "number"
+        },
+        "minimum": {
+            "type": "number"
+        },
+        "exclusiveMinimum": {
+            "type": "number"
+        },
+        "maxLength": {
+            "$ref": "#/definitions/nonNegativeInteger"
+        },
+        "minLength": {
+            "$ref": "#/definitions/nonNegativeIntegerDefault0"
+        },
+        "pattern": {
+            "type": "string",
+            "format": "regex"
+        },
+        "additionalItems": {
+            "$ref": "#"
+        },
+        "items": {
+            "anyOf": [
+                {
+                    "$ref": "#"
+                },
+                {
+                    "$ref": "#/definitions/schemaArray"
+                }
+            ],
+            "default": true
+        },
+        "maxItems": {
+            "$ref": "#/definitions/nonNegativeInteger"
+        },
+        "minItems": {
+            "$ref": "#/definitions/nonNegativeIntegerDefault0"
+        },
+        "uniqueItems": {
+            "type": "boolean",
+            "default": false
+        },
+        "contains": {
+            "$ref": "#"
+        },
+        "maxProperties": {
+            "$ref": "#/definitions/nonNegativeInteger"
+        },
+        "minProperties": {
+            "$ref": "#/definitions/nonNegativeIntegerDefault0"
+        },
+        "required": {
+            "$ref": "#/definitions/stringArray"
+        },
+        "additionalProperties": {
+            "$ref": "#"
+        },
+        "definitions": {
+            "type": "object",
+            "additionalProperties": {
+                "$ref": "#"
+            },
+            "default": {}
+        },
+        "properties": {
+            "type": "object",
+            "additionalProperties": {
+                "$ref": "#"
+            },
+            "default": {}
+        },
+        "patternProperties": {
+            "type": "object",
+            "additionalProperties": {
+                "$ref": "#"
+            },
+            "propertyNames": {
+                "format": "regex"
+            },
+            "default": {}
+        },
+        "dependencies": {
+            "type": "object",
+            "additionalProperties": {
+                "anyOf": [
+                    {
+                        "$ref": "#"
+                    },
+                    {
+                        "$ref": "#/definitions/stringArray"
+                    }
+                ]
+            }
+        },
+        "propertyNames": {
+            "$ref": "#"
+        },
+        "const": true,
+        "enum": {
+            "type": "array",
+            "items": true,
+            "minItems": 1,
+            "uniqueItems": true
+        },
+        "type": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/simpleTypes"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/simpleTypes"
+                    },
+                    "minItems": 1,
+                    "uniqueItems": true
+                }
+            ]
+        },
+        "format": {
+            "type": "string"
+        },
+        "contentMediaType": {
+            "type": "string"
+        },
+        "contentEncoding": {
+            "type": "string"
+        },
+        "if": {
+            "$ref": "#"
+        },
+        "then": {
+            "$ref": "#"
+        },
+        "else": {
+            "$ref": "#"
+        },
+        "allOf": {
+            "$ref": "#/definitions/schemaArray"
+        },
+        "anyOf": {
+            "$ref": "#/definitions/schemaArray"
+        },
+        "oneOf": {
+            "$ref": "#/definitions/schemaArray"
+        },
+        "not": {
+            "$ref": "#"
+        }
+    },
+    "default": true
+}
diff --git a/metadata/v10/metaschema/draft07/schema.py b/metadata/v10/metaschema/draft07/schema.py
@@ -0,0 +1,5 @@
+import json
+import os
+
+with open(os.path.join(os.path.dirname(__file__), "schema.json"), "rb") as f:
+    OEMETADATA_METASCHEMA_DRAFT07_SCHEMA = json.loads(f.read())
diff --git a/tests/metadata/v10/metaschema/__init__.py b/tests/metadata/v10/metaschema/__init__.py
diff --git a/tests/metadata/v10/metaschema/draft07/__init__.py b/tests/metadata/v10/metaschema/draft07/__init__.py
diff --git a/tests/metadata/v10/metaschema/draft07/test_schema.py b/tests/metadata/v10/metaschema/draft07/test_schema.py
@@ -0,0 +1,12 @@
+def test_if_schema_json_loads_successfully():
+    try:
+        from metadata.metaschema.draft07.schema import OEMETADATA_METASCHEMA_DRAFT07_SCHEMA
+    except Warning:
+        print("Can´t load Metaschema. Check if the files are missing!")
+
+
+def test_if_schema_json_has_correct_schema_and_id_set():
+    from metadata.metaschema.draft07.schema import OEMETADATA_METASCHEMA_DRAFT07_SCHEMA
+
+    assert OEMETADATA_METASCHEMA_DRAFT07_SCHEMA["$schema"] == "http://json-schema.org/draft-07/schema#"
+    assert OEMETADATA_METASCHEMA_DRAFT07_SCHEMA["$id"] == "http://json-schema.org/draft-07/schema#"