Add a cite field

flywheel-io · Nov 3, 2017 · e539836 · e539836
1 parent d596bee
commit e539836
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/spec/manifest.schema.json b/spec/manifest.schema.json
@@ -34,6 +34,11 @@
 			"maxLength": 100,
 			"description": "(optional) The maintainer of this gear. Can be used to distinguish the algorithm author from the gear maintainer."
 		},
+		"cite": {
+			"type": "string",
+			"maxLength": 5000,
+			"description": "(optional) Any citations relevant to the algorithm(s) or work present in the gear."
+		},
 		"config": {
 			"type": "object",
 			"additionalProperties": {

diff --git a/spec/readme.md b/spec/readme.md
@@ -1,4 +1,4 @@
-# Flywheel Gear Spec (v0.1.3)
+# Flywheel Gear Spec (v0.1.4)
 
 This document describes the structure of a Flywheel Gear.
 
@@ -49,6 +49,9 @@ Note, the `// comments` shown below are not JSON syntax and cannot be included i
 	// Can be the same as the author field if both roles were filled by the same individual.
 	"maintainer":  "Nathaniel Kofalt",
 
+	// (Optional) Any citations you wish to add.
+	"cite":  "",
+
 	// Must be an OSI-approved SPDX license string or 'Other'. Ref: https://spdx.org/licenses
 	"license": "Apache-2.0",