update: refine checks schema

Exabyte-io · Sep 1, 2023 · af2beec · af2beec
1 parent 16c5f48
commit af2beec
Showing 1 changed file with 17 additions and 9 deletions.
diff --git a/schema/system/consistency_checks.json b/schema/system/consistency_checks.json
@@ -9,28 +9,36 @@
         "type": "object",
         "properties": {
           "name": {
-            "type": "string"
+            "type": "string",
+            "description": "Name of the consistency check which comes from an exported enum."
           },
           "description": {
-            "type": "string"
+            "type": "string",
+            "description": "Description of the consistency check provided for developers."
           },
-          "severity": {
-            "enum": ["info", "warning", "error"]
+          "keys": {
+            "type": "array",
+            "items": {}
           },
           "arguments": {
-            "type": "object"
+            "type": "array",
+            "items": {
+              "type": "object"
+            },
+            "description": "Arguments provided by consistency check function for message construction, specific to each check."
+          },
+          "severity": {
+            "enum": ["info", "warning", "error"]
           },
           "message": {
             "type": "string"
-          },
-          "enabled": {
-            "type": "boolean"
           }
         },
         "required": [
           "name",
-          "severity",
+          "keys",
           "arguments",
+          "severity",
           "message"
         ]
       }