Improve native workflow JSON schema

Fix some types and add example documentation for `a_galaxy_workflow` property
davelopez · Apr 3, 2022 · 5ef6ece · 5ef6ece
1 parent 8abe4f9
commit 5ef6ece
Showing 1 changed file with 21 additions and 11 deletions.
diff --git a/workflow-languages/schemas/native.schema.json b/workflow-languages/schemas/native.schema.json
@@ -4,7 +4,13 @@
     "type": "object",
     "properties": {
         "a_galaxy_workflow": {
-            "type": "string"
+            "type": "string",
+            "title": "## Galaxy Workflow indicator",
+            "markdownDescription": "Indicates that this JSON document is a **Galaxy Workflow**",
+            "default": "true",
+            "enum": [
+                "true"
+            ]
         },
         "annotation": {
             "type": "string"
@@ -47,7 +53,7 @@
         },
         "steps": {
             "type": "object",
-            "$ref": "#/definitions/stepDef"
+            "$ref": "#/definitions/step"
         },
         "tags": {
             "type": "array",
@@ -77,17 +83,18 @@
         "uuid"
     ],
     "definitions": {
-        "stepDef": {
+        "step": {
             "type": "object",
+            "additionalProperties": false,
             "patternProperties": {
-                "[0-9]*": {
+                "^[0-9]*$": {
                     "type": "object",
                     "properties": {
                         "annotation": {
                             "type": "string"
                         },
                         "content_id": {
-                            "type": "string"
+                            "$ref": "#/definitions/optionalString"
                         },
                         "errors": {
                             "type": "null"
@@ -119,7 +126,7 @@
                             ]
                         },
                         "label": {
-                            "type": "string"
+                            "$ref": "#/definitions/optionalString"
                         },
                         "name": {
                             "type": "string"
@@ -158,13 +165,13 @@
                             }
                         },
                         "tool_id": {
-                            "type": "null"
+                            "$ref": "#/definitions/optionalString"
                         },
                         "tool_state": {
                             "type": "string"
                         },
                         "tool_version": {
-                            "type": "null"
+                            "$ref": "#/definitions/optionalString"
                         },
                         "type": {
                             "type": "string"
@@ -179,22 +186,25 @@
                     },
                     "required": [
                         "annotation",
-                        "content_id",
                         "id",
                         "input_connections",
                         "inputs",
                         "name",
                         "outputs",
                         "position",
                         "tool_id",
-                        "tool_state",
-                        "tool_version",
                         "type",
                         "uuid",
                         "workflow_outputs"
                     ]
                 }
             }
+        },
+        "optionalString": {
+            "type": [
+                "string",
+                "null"
+            ]
         }
     }
 }