New Actions Files

.github/workflows/check-json.yml

@@ -4,13 +4,26 @@ on:
   push:
     paths:
       - '**.json'
+      - '**.yml'
+      - '**.yaml'
+
+env:
+  PYTHON_VERSION: 3.11.6
 
 jobs:
-  json-check:
+  check-schemata:
+    name: Check Schemata
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - name: json-syntax-check
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Install dependencies
+        run: python -m pip install jsonschema pyyaml
+      - name: Check JSON Syntax
         uses: limitusus/json-syntax-check@v2
         with:
           pattern: "\\.json$"
+      - name: Check Actions Schema
+        run: python -c 'import yaml,json,jsonschema,sys;jsonschema.validate(yaml.load(open(sys.argv[1]), yaml.Loader), json.load(open(sys.argv[2])))' actions.yml actions.schema.json

actions.schema.json

@@ -0,0 +1,131 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "actions",
+  "type": "object",
+  "patternProperties": {
+    ".*": {
+      "type": "object",
+      "required": [
+        "name",
+        "action"
+      ],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "action": {
+          "type": "string",
+          "enum": [
+            "convert",
+            "extract",
+            "manual",
+            "rename",
+            "ignore",
+            "reidentify"
+          ]
+        },
+        "convert": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": [
+              "converter",
+              "converter_type",
+              "outputs"
+            ],
+            "properties": {
+              "converter": {
+                "type": "string"
+              },
+              "converter_type": {
+                "type": "string",
+                "enum": [
+                  "master",
+                  "statutory",
+                  "access"
+                ]
+              },
+              "outputs": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "minItems": 1
+              }
+            }
+          }
+        },
+        "extract": {
+          "type": "object",
+          "required": [
+            "tool",
+            "extension",
+            "dir_suffix"
+          ],
+          "properties": {
+            "tool": {
+              "type": "string"
+            },
+            "extension": {
+              "type": "string"
+            },
+            "dir_suffix": {
+              "type": "string"
+            }
+          }
+        },
+        "manual": {
+          "type": "object",
+          "properties": {
+            "reasoning": {
+              "type": "string"
+            },
+            "process": {
+              "type": "string"
+            }
+          }
+        },
+        "rename": {
+          "type": "object",
+          "properties": {
+            "new_name": {
+              "type": "string"
+            }
+          }
+        },
+        "reidentify": {
+          "type": "object",
+          "required": [
+            "reasoning"
+          ],
+          "properties": {
+            "reasoning": {
+              "type": "string"
+            },
+            "onfail": {
+              "type": "string",
+              "enum": [
+                "convert",
+                "extract",
+                "manual",
+                "rename",
+                "ignore"
+              ]
+            }
+          }
+        },
+        "ignore": {
+          "type": "object",
+          "properties": {
+            "reasoning": {
+              "type": "string"
+            }
+          }
+        }
+      }
+    }
+  }
+}