[ARVADOS] created: 5ce1225be2b74fa8b2025b0f52e72b86629fecc1
git at public.curoverse.com
git at public.curoverse.com
Wed Aug 6 10:48:58 EDT 2014
at 5ce1225be2b74fa8b2025b0f52e72b86629fecc1 (commit)
commit 5ce1225be2b74fa8b2025b0f52e72b86629fecc1
Author: Peter Amstutz <peter.amstutz at curoverse.com>
Date: Wed Aug 6 10:48:52 2014 -0400
Add documentation to PipelineTemplate schema for title, description, link_name of pipeline template script_parameters.
diff --git a/doc/api/schema/PipelineTemplate.html.textile.liquid b/doc/api/schema/PipelineTemplate.html.textile.liquid
index a16ed51..412810f 100644
--- a/doc/api/schema/PipelineTemplate.html.textile.liquid
+++ b/doc/api/schema/PipelineTemplate.html.textile.liquid
@@ -23,6 +23,9 @@ table(table table-bordered table-condensed).
|dataclass |string |One of 'Collection', 'File' [1], 'number', or 'text' |Data type of this parameter.|
|search_for |string |any string |Substring to use as a default search string when choosing inputs.|
|output_of |string |the name of another component in the pipeline |Specifies that the value of this parameter should be set to the 'output' attribute of the job that corresponds to the specified component.|
+|title |string |any string |User friendly title to display when choosing parameter values|
+|description |string |any string |Extended text description for describing expected/valid values for the script parameter|
+|link_name |string |any string |User friendly name to display for the parameter value instead of the actual parameter value|
The 'output_of' parameter is especially important, as this is how components are actually linked together to form a pipeline. Component jobs that depend on the output of other components do not run until the parent job completes and has produced output. If the parent job fails, the entire pipeline fails.
@@ -46,7 +49,8 @@ This is a pipeline named "Filter MD5 hash values" with two components, "do_hash"
"input": {
"required": true,
"dataclass": "Collection",
- "search_for": ".fastq.gz"
+ "search_for": ".fastq.gz",
+ "title":"Please select a fastq file"
}
},
},
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list