First implementation (#1)

Reviewed-on: #1
2026-10-15 05:47:05 -04:00
1 parent 34c0abb26a
commit 4fa326dc76
@@ -0,0 +1,151 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://paperspec.scient.ing/schemas/checklist.schema.json",
+  "title": "Conformance checklist",
+  "description": "scienting-checklist/1: a check of an export against a named standard, covered by a receipt; spec/08-fidelity.md §8.11.",
+  "type": "object",
+  "properties": {
+    "format": {
+      "const": "scienting-checklist/1"
+    },
+    "id": {
+      "$ref": "common.schema.json#/$defs/recordId"
+    },
+    "doc": {
+      "$ref": "common.schema.json#/$defs/qualifiedKey"
+    },
+    "rev": {
+      "type": "integer",
+      "minimum": 0
+    },
+    "standard": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "level": {
+          "type": "string",
+          "minLength": 1
+        },
+        "url": {
+          "$ref": "common.schema.json#/$defs/url"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "additionalProperties": false
+    },
+    "export": {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "enum": [
+            "html",
+            "pdf",
+            "epub",
+            "other"
+          ]
+        },
+        "sha256": {
+          "$ref": "common.schema.json#/$defs/hash"
+        },
+        "size": {
+          "type": "integer",
+          "minimum": 0
+        }
+      },
+      "required": [
+        "kind",
+        "sha256"
+      ],
+      "additionalProperties": false
+    },
+    "items": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "criterion": {
+            "type": "string",
+            "minLength": 1
+          },
+          "result": {
+            "enum": [
+              "pass",
+              "fail",
+              "not-applicable"
+            ]
+          },
+          "method": {
+            "enum": [
+              "manual",
+              "automated"
+            ]
+          },
+          "tool": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "minLength": 1
+              },
+              "version": {
+                "type": "string",
+                "minLength": 1
+              }
+            },
+            "required": [
+              "name",
+              "version"
+            ],
+            "additionalProperties": false
+          },
+          "note": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "required": [
+          "criterion",
+          "result",
+          "method"
+        ],
+        "additionalProperties": false,
+        "if": {
+          "properties": {
+            "method": {
+              "const": "automated"
+            }
+          }
+        },
+        "then": {
+          "required": [
+            "tool"
+          ]
+        }
+      },
+      "minItems": 1
+    },
+    "by": {
+      "$ref": "common.schema.json#/$defs/key"
+    },
+    "at": {
+      "$ref": "common.schema.json#/$defs/time"
+    }
+  },
+  "required": [
+    "format",
+    "id",
+    "doc",
+    "rev",
+    "standard",
+    "export",
+    "items",
+    "by",
+    "at"
+  ],
+  "additionalProperties": false
+}