Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documenting comments to orderly.json schema #201

Merged
merged 4 commits into from
Dec 13, 2024
Merged

Add documenting comments to orderly.json schema #201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dc32948
Add documenting comments to orderly.json schema
david-mears-2 Nov 29, 2024
ad70c6b
Update version number
david-mears-2 Nov 29, 2024
3684542
Merge remote-tracking branch 'origin/main' into document-orderly-schema
richfitz Dec 13, 2024
ed1e7d8
Bump version
richfitz Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"),
Expand Down
5 changes: 4 additions & 1 deletion inst/schema/orderly/orderly.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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": {
Expand All @@ -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",
Expand Down
Loading