3016: schema doc updated with new search_for attribute details.

diff --git a/doc/api/schema/PipelineTemplate.html.textile.liquid b/doc/api/schema/PipelineTemplate.html.textile.liquid
index 9e81ec05f3b537c07d6655e3b7513f7a0302b9af..b23d01c76d572f7ac7ff4c6577df0fcf1b7bdd62 100644 (file)
--- a/doc/api/schema/PipelineTemplate.html.textile.liquid
+++ b/doc/api/schema/PipelineTemplate.html.textile.liquid
@@ -21,12 +21,15 @@ table(table table-bordered table-condensed).
 |default         |any     |any                                              |The default value for this parameter.|
 |required        |boolean |true or false                                    |Specifies whether the parameter is required to have a value or not.|
 |dataclass       |string  |One of 'Collection', 'File' [1], 'number', or 'text' |Data type of this parameter.|
+|search_for      |string  |any string                                       |Substring to look for in input collection or file name identifier.|
 |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.|
 
 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.
 
 fn1. The 'File' type refers to a specific file within a Keep collection in the form 'collection_hash/filename', for example '887cd41e9c613463eab2f0d885c6dd96+83/bob.txt'.
 
+The 'search_for' parameter is meaningful only when input dataclass of type Collection or File is used. If a value is provided, this will be preloaded into the input data chooser dialog. For example, if your input dataclass is a File and you are interested in a certain filename exetention, you can preconfigure it in this attribute.
+
 h3. Examples
 
 This is a pipeline named "Filter MD5 hash values" with two components, "do_hash" and "filter".  The "input" script parameter of the "do_hash" component is required to be filled in by the user, and the expected data type is "Collection".  This also specifies that the "input" script parameter of the "filter" component is the output of "do_hash", so "filter" will not run until "do_hash" completes successfully.  When the pipeline runs, past jobs that meet the criteria described above may be substituted for either or both components to avoid redundant computation.
@@ -42,7 +45,8 @@ This is a pipeline named "Filter MD5 hash values" with two components, "do_hash"
       "script_parameters": {
         "input": {
           "required": true,
-          "dataclass": "Collection"
+          "dataclass": "Collection",
+          "search_for": "FASTQ"
         }
       },
     },