From e5398363022233013fcc8637cf245b0d38af054c Mon Sep 17 00:00:00 2001 From: Nathaniel Kofalt Date: Fri, 3 Nov 2017 13:04:03 -0500 Subject: [PATCH] Add a cite field --- spec/manifest.schema.json | 5 +++++ spec/readme.md | 5 ++++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/spec/manifest.schema.json b/spec/manifest.schema.json index 4cd30e4..7e788f3 100644 --- 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 index b46d858..a80de44 100644 --- 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",