update: add description

Exabyte-io · Oct 26, 2023 · 19d14ec · 19d14ec
1 parent 8755806
commit 19d14ec
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/schema/in_memory_entity/base.json b/schema/in_memory_entity/base.json
@@ -20,7 +20,7 @@
         "systemName": {
             "type": "string"
         },
-        "consistency_checks": {
+        "consistencyChecks": {
             "type": "array",
             "items": {
                 "$ref": "../system/consistency_check.json"

diff --git a/schema/system/consistency_check.json b/schema/system/consistency_check.json
@@ -3,27 +3,30 @@
     "$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, e.g. 'basis.coordinates.1'"
+            "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 which is exported as an enum"
+            "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"
+            "type": "string",
+            "description": "Message generated by the consistency check describing the problem."
         }
     },
     "required": [