Merge pull request #264 from Exabyte-io/feature/SOF-6588

Feature/SOF-6588 feat: add ConsistencyChecks schema

example/system/consistency_check.json

@@ -0,0 +1,6 @@
+{
+    "key": "basis.coordinates.0",
+    "name": "atomsTooClose",
+    "severity": "warning",
+    "message": "Atom 0 is too close to atom X"
+}

schema/in_memory_entity/base.json

@@ -19,6 +19,12 @@
         },
         "systemName": {
             "type": "string"
+        },
+        "consistencyChecks": {
+            "type": "array",
+            "items": {
+                "$ref": "../system/consistency_check.json"
+            }
         }
     }
 }

schema/system/consistency_check.json

@@ -0,0 +1,38 @@
+{
+    "$id": "system/consistency-check",
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "consistency check",
+    "type": "object",
+    "description": "The output of consistency checks performed on data adhering to JSON schema, but inconsistent with scientific or logical rules, to show problems in UI.",
+    "properties": {
+        "key": {
+            "type": "string",
+            "description": "Key of the property of the entity on which the consistency check is performed in Mongo dot notation, e.g. 'basis.coordinates.1'"
+        },
+        "name": {
+            "enum": [
+                "default",
+                "atomsTooClose"
+            ],
+            "description": "Name of the consistency check that is performed, which is listed in an enum."
+        },
+        "severity": {
+            "enum": [
+                "info",
+                "warning",
+                "error"
+            ],
+            "description": "Severity level of the problem, which is used in UI to differentiate."
+        },
+        "message": {
+            "type": "string",
+            "description": "Message generated by the consistency check describing the problem."
+        }
+    },
+    "required": [
+        "key",
+        "name",
+        "severity",
+        "message"
+    ]
+}