Merge pull request #201 from mrc-ide/document-orderly-schema

Add documenting comments to orderly.json schema
mrc-ide · Dec 13, 2024 · d9ab97c · d9ab97c
2 parents da43738 + ed1e7d8
commit d9ab97c
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: orderly2
 Title: Orderly Next Generation
-Version: 1.99.58
+Version: 1.99.59
 Authors@R: c(person("Rich", "FitzJohn", role = c("aut", "cre"),
                     email = "[email protected]"),
              person("Robert", "Ashton", role = "aut"),

diff --git a/inst/schema/orderly/orderly.json b/inst/schema/orderly/orderly.json
@@ -6,6 +6,7 @@
     "type": "object",
     "properties": {
         "artefacts": {
+            "comment": "Artefacts are sets of (at least 1) output files that result from running a packet",
             "type": "array",
             "items": {
                 "type": "object",
@@ -40,6 +41,7 @@
             }
         },
         "role": {
+            "comment": "Assigns a 'role' (category) to input files. Any file that is not an output is considered an input.",
             "type": "array",
             "items": {
                 "type": "object",
@@ -72,7 +74,7 @@
         },
 
         "session": {
-            "description": "Information about the session",
+            "description": "Information about the session in which the packet was run",
             "type": "object",
             "properties": {
                 "platform": {
@@ -91,6 +93,7 @@
                     "required": ["version", "os", "system"]
                 },
                 "packages": {
+                    "comment": "Records metadata on the packages that were loaded during the session",  
                     "type": "array",
                     "items": {
                         "type": "object",