From dc32948ee6ae5dac11899522b17e090ed210dab0 Mon Sep 17 00:00:00 2001
From: David Mears <60350599+david-mears-2@users.noreply.github.com>
Date: Fri, 29 Nov 2024 14:40:54 +0000
Subject: [PATCH 1/3] Add documenting comments to orderly.json schema

To clarify the intent behind the properties/what terms refer to
---
 inst/schema/orderly/orderly.json | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/inst/schema/orderly/orderly.json b/inst/schema/orderly/orderly.json
index 0b1261ca..0914bb67 100644
--- 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",

From ad70c6b9a587f486dc447119e2517c114571c611 Mon Sep 17 00:00:00 2001
From: David Mears <60350599+david-mears-2@users.noreply.github.com>
Date: Fri, 29 Nov 2024 15:08:48 +0000
Subject: [PATCH 2/3] Update version number

---
 DESCRIPTION | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/DESCRIPTION b/DESCRIPTION
index b8bd1aca..31a70c05 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: orderly2
 Title: Orderly Next Generation
-Version: 1.99.57
+Version: 1.99.58
 Authors@R: c(person("Rich", "FitzJohn", role = c("aut", "cre"),
                     email = "rich.fitzjohn@gmail.com"),
              person("Robert", "Ashton", role = "aut"),

From ed1e7d88aafcb7f722afdf2e475eecf7712c76c6 Mon Sep 17 00:00:00 2001
From: Rich FitzJohn <r.fitzjohn@imperial.ac.uk>
Date: Fri, 13 Dec 2024 10:25:21 +0000
Subject: [PATCH 3/3] Bump version

---
 DESCRIPTION | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/DESCRIPTION b/DESCRIPTION
index 31a70c05..990bbff8 100644
--- 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 = "rich.fitzjohn@gmail.com"),
              person("Robert", "Ashton", role = "aut"),