Defines the type of the array elements.
-Must be array
ValidationException If the document fragment is not a {@link Dictionary} or validation of fields fails.
diff --git a/typescript/docs/classes/EnumSchema.html b/typescript/docs/classes/EnumSchema.html index 390e90a..5f5b97a 100644 --- a/typescript/docs/classes/EnumSchema.html +++ b/typescript/docs/classes/EnumSchema.html @@ -1,11 +1,11 @@Auto-generated class implementation for https://w3id.org/cwl/salad#EnumSchema
Define an enumerated type.
-Defines the set of valid symbols.
-Must be enum
ValidationException If the document fragment is not a {@link Dictionary} or validation of fields fails.
diff --git a/typescript/docs/classes/GalaxyWorkflow.html b/typescript/docs/classes/GalaxyWorkflow.html index 47f61d1..e8f2fbc 100644 --- a/typescript/docs/classes/GalaxyWorkflow.html +++ b/typescript/docs/classes/GalaxyWorkflow.html @@ -12,13 +12,13 @@label field.label.
-Can be a schema.org Person (https://schema.org/Person) or Organization (https://schema.org/Organization) entity
-A documentation string for this object, or an array of strings which should be concatenated.
-The unique identifier for this object.
-Defines the input parameters of the process. The process is ready to run when all required input parameters are associated with concrete values. Input parameters include a schema for each parameter which is @@ -29,25 +29,25 @@
label field.null (or the value of default for that
parameter, if provided) for the purposes of validation and evaluation
of expressions.
-A short, human-readable label of this object.
-Must be a valid license listed at https://spdx.org/licenses/
-Defines the parameters representing the output of the process. May be used to generate and/or validate the output object.
-If listed should correspond to the release of the workflow in its source reposiory.
-Workflow invocation report template.
-The individual steps that make up the workflow. Each step is executed when all of its input data links are fulfilled.
-Tags for the workflow.
-UUID uniquely representing this element.
-ValidationException If the document fragment is not a {@link Dictionary} or validation of fields fails.
diff --git a/typescript/docs/classes/RecordField.html b/typescript/docs/classes/RecordField.html index 86c9dcf..dfc8d6f 100644 --- a/typescript/docs/classes/RecordField.html +++ b/typescript/docs/classes/RecordField.html @@ -1,13 +1,13 @@Auto-generated class implementation for https://w3id.org/cwl/salad#RecordField
A field of a record.
-A documentation string for this object, or an array of strings which should be concatenated.
-The name of the field
-The field type
-ValidationException If the document fragment is not a {@link Dictionary} or validation of fields fails.
diff --git a/typescript/docs/classes/RecordSchema.html b/typescript/docs/classes/RecordSchema.html index 78b3983..9eb1384 100644 --- a/typescript/docs/classes/RecordSchema.html +++ b/typescript/docs/classes/RecordSchema.html @@ -1,10 +1,10 @@Auto-generated class implementation for https://w3id.org/cwl/salad#RecordSchema
-Defines the fields of the record.
-Must be record
ValidationException If the document fragment is not a {@link Dictionary} or validation of fields fails.
diff --git a/typescript/docs/classes/Report.html b/typescript/docs/classes/Report.html index 13e7188..96cb48a 100644 --- a/typescript/docs/classes/Report.html +++ b/typescript/docs/classes/Report.html @@ -2,9 +2,9 @@Auto-generated class implementation for https://galaxyproject.org/gxformat2/v19_09#Report
Definition of an invocation report for this workflow. Currently the only field is 'markdown'.
-Galaxy flavored Markdown to define an invocation report.
-ValidationException If the document fragment is not a {@link Dictionary} or validation of fields fails.
diff --git a/typescript/docs/classes/StepPosition.html b/typescript/docs/classes/StepPosition.html index 94abb3c..903322f 100644 --- a/typescript/docs/classes/StepPosition.html +++ b/typescript/docs/classes/StepPosition.html @@ -1,11 +1,11 @@Auto-generated class implementation for https://galaxyproject.org/gxformat2/gxformat2common#StepPosition
This field specifies the location of the step's node when rendered in the workflow editor.
-Relative horizontal position of the step's node when rendered in the workflow editor.
-Relative vertical position of the step's node when rendered in the workflow editor.
-ValidationException If the document fragment is not a {@link Dictionary} or validation of fields fails.
diff --git a/typescript/docs/classes/ToolShedRepository.html b/typescript/docs/classes/ToolShedRepository.html index a28429c..4158304 100644 --- a/typescript/docs/classes/ToolShedRepository.html +++ b/typescript/docs/classes/ToolShedRepository.html @@ -1,14 +1,14 @@Auto-generated class implementation for https://galaxyproject.org/gxformat2/gxformat2common#ToolShedRepository
-The revision of the tool shed repository this tool can be found in.
-The name of the tool shed repository this tool can be found in.
-The owner of the tool shed repository this tool can be found in.
-The URI of the tool shed containing the repository this tool can be found in - typically this should be toolshed.g2.bx.psu.edu.
-ValidationException If the document fragment is not a {@link Dictionary} or validation of fields fails.
diff --git a/typescript/docs/classes/ValidationException.html b/typescript/docs/classes/ValidationException.html index 1d5780e..7b6a013 100644 --- a/typescript/docs/classes/ValidationException.html +++ b/typescript/docs/classes/ValidationException.html @@ -1,6 +1,6 @@ -Optional override for formatting stack traces
Create .stack property on a target object
Generated using TypeDoc
Auto-generated class implementation for https://galaxyproject.org/gxformat2/v19_09#WorkflowInputParameter
-Collection type (defaults to list if type is collection). Nested
collection types are separated with colons, e.g. list:list:paired.
The default value to use for this parameter if the parameter is missing
from the input object, or if the value of the parameter in the input
object is null. Default values are applied before evaluating expressions
(e.g. dependent valueFrom fields).
A documentation string for this object, or an array of strings which should be concatenated.
-Specify datatype extension for valid input datasets.
-The unique identifier for this object.
-A short, human-readable label of this object.
-If set to true, WorkflowInputParameter is not required to submit the workflow.
Specify valid types of data that may be assigned to this parameter.
-ValidationException If the document fragment is not a {@link Dictionary} or validation of fields fails.
diff --git a/typescript/docs/classes/WorkflowOutputParameter.html b/typescript/docs/classes/WorkflowOutputParameter.html index 1bdb6fc..327bec8 100644 --- a/typescript/docs/classes/WorkflowOutputParameter.html +++ b/typescript/docs/classes/WorkflowOutputParameter.html @@ -4,18 +4,18 @@ connected to one parameter defined in the workflow that will provide the value of the output parameter. It is legal to connect a WorkflowInputParameter to a WorkflowOutputParameter. -A documentation string for this object, or an array of strings which should be concatenated.
-The unique identifier for this object.
-A short, human-readable label of this object.
-Specifies workflow parameter that supply the value of to the output parameter.
-Specify valid types of data that may be assigned to this parameter.
-ValidationException If the document fragment is not a {@link Dictionary} or validation of fields fails.
diff --git a/typescript/docs/classes/WorkflowStep.html b/typescript/docs/classes/WorkflowStep.html index 4689ab6..13b482c 100644 --- a/typescript/docs/classes/WorkflowStep.html +++ b/typescript/docs/classes/WorkflowStep.html @@ -14,53 +14,53 @@state and tool_state fields.state can contained a typed map. Repeat values can be represented as YAML arrays. An alternative
to representing state this way is defining inputs with default values.
A documentation string for this object, or an array of strings which should be concatenated.
-During Galaxy export there may be some problem validating the tool state, tool used, etc.. that will be indicated by this field. The Galaxy user should be warned of these problems before the workflow can be used in Galaxy.
This field should not be used in human written Galaxy workflow files.
A typical problem is the referenced tool is not installed, this can be fixed by installed the tool and re-saving the workflow and then re-exporting it.
-The unique identifier for this object.
-Defines the input parameters of the workflow step. The process is ready to run when all required input parameters are associated with concrete values. Input parameters include a schema for each parameter which is used to validate the input object. It may also be used build a user interface for constructing the input object.
-A short, human-readable label of this object.
-Defines the parameters representing the output of the process. May be used to generate and/or validate the output object.
This can also be called 'outputs' for legacy reasons - but the resulting workflow document is not a valid instance of this schema.
-Specifies a subworkflow to run.
-Structured tool state.
-The tool ID used to run this step of the workflow (e.g. 'cat1' or 'toolshed.g2.bx.psu.edu/repos/nml/collapse_collections/collapse_dataset/4.0').
-The Galaxy Tool Shed repository that should be installed in order to use this tool.
-Unstructured tool state.
-The tool version corresponding used to run this step of the workflow. For tool shed installed tools, the ID generally uniquely specifies a version and this field is optional.
-Workflow step module's type (defaults to 'tool').
-UUID uniquely representing this element.
-If defined, only run the step when the expression evaluates to
true. If false the step is skipped. A skipped step
produces a null on each output.
Expression should be an ecma5.1 expression.
-ValidationException If the document fragment is not a {@link Dictionary} or validation of fields fails.
diff --git a/typescript/docs/classes/WorkflowStepInput.html b/typescript/docs/classes/WorkflowStepInput.html index 8e0acf9..7e8588a 100644 --- a/typescript/docs/classes/WorkflowStepInput.html +++ b/typescript/docs/classes/WorkflowStepInput.html @@ -1,18 +1,18 @@Auto-generated class implementation for https://galaxyproject.org/gxformat2/v19_09#WorkflowStepInput
TODO:
-The default value for this parameter to use if either there is no
source field, or the value produced by the source is null. The
default must be applied prior to scattering or evaluating valueFrom.
The unique identifier for this object.
-A short, human-readable label of this object.
-Specifies one or more workflow parameters that will provide input to the underlying step parameter.
-ValidationException If the document fragment is not a {@link Dictionary} or validation of fields fails.
diff --git a/typescript/docs/classes/WorkflowStepOutput.html b/typescript/docs/classes/WorkflowStepOutput.html index 1f54c76..29981a4 100644 --- a/typescript/docs/classes/WorkflowStepOutput.html +++ b/typescript/docs/classes/WorkflowStepOutput.html @@ -7,9 +7,9 @@A unique identifier for this workflow output parameter. This is
the identifier to use in the source field of WorkflowStepInput
to connect the output value to downstream parameters.
The unique identifier for this object.
-ValidationException If the document fragment is not a {@link Dictionary} or validation of fields fails.
diff --git a/typescript/docs/enums/Any.html b/typescript/docs/enums/Any.html index 8f12e21..95c3c7f 100644 --- a/typescript/docs/enums/Any.html +++ b/typescript/docs/enums/Any.html @@ -1 +1 @@ -Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Auto-generated interface for https://w3id.org/cwl/salad#ArraySchema
-Defines the type of the array elements.
-Must be array
Generated using TypeDoc
Auto-generated interface for https://w3id.org/cwl/salad#Documented
-A documentation string for this object, or an array of strings which should be concatenated.
Generated using TypeDoc
Auto-generated interface for https://w3id.org/cwl/salad#EnumSchema
Define an enumerated type.
-Defines the set of valid symbols.
-Must be enum
Generated using TypeDoc
label field.label.
-Can be a schema.org Person (https://schema.org/Person) or Organization (https://schema.org/Organization) entity
-A documentation string for this object, or an array of strings which should be concatenated.
-The unique identifier for this object.
-Defines the input parameters of the process. The process is ready to run when all required input parameters are associated with concrete values. Input parameters include a schema for each parameter which is @@ -29,22 +29,22 @@
label field.null (or the value of default for that
parameter, if provided) for the purposes of validation and evaluation
of expressions.
-A short, human-readable label of this object.
-Must be a valid license listed at https://spdx.org/licenses/
-Defines the parameters representing the output of the process. May be used to generate and/or validate the output object.
-If listed should correspond to the release of the workflow in its source reposiory.
-Workflow invocation report template.
-The individual steps that make up the workflow. Each step is executed when all of its input data links are fulfilled.
-Tags for the workflow.
-UUID uniquely representing this element.
Generated using TypeDoc
Auto-generated interface for https://galaxyproject.org/gxformat2/gxformat2common#HasStepErrors
-During Galaxy export there may be some problem validating the tool state, tool used, etc.. that will be indicated by this field. The Galaxy user should be warned of these problems before the workflow can be used in Galaxy.
diff --git a/typescript/docs/interfaces/HasStepPositionProperties.html b/typescript/docs/interfaces/HasStepPositionProperties.html index 532e645..c326e4d 100644 --- a/typescript/docs/interfaces/HasStepPositionProperties.html +++ b/typescript/docs/interfaces/HasStepPositionProperties.html @@ -1,3 +1,3 @@Auto-generated interface for https://galaxyproject.org/gxformat2/gxformat2common#HasStepPosition
-Generated using TypeDoc
Generated using TypeDoc
Auto-generated interface for https://galaxyproject.org/gxformat2/gxformat2common#HasUUID
-UUID uniquely representing this element.
Generated using TypeDoc
Auto-generated interface for https://w3id.org/cwl/cwl#Identified
-The unique identifier for this object.
Generated using TypeDoc
Auto-generated interface for https://w3id.org/cwl/cwl#InputParameter
-The default value to use for this parameter if the parameter is missing
from the input object, or if the value of the parameter in the input
object is null. Default values are applied before evaluating expressions
(e.g. dependent valueFrom fields).
A documentation string for this object, or an array of strings which should be concatenated.
-The unique identifier for this object.
-A short, human-readable label of this object.
Generated using TypeDoc
Auto-generated interface for https://w3id.org/cwl/cwl#Labeled
-A short, human-readable label of this object.
Generated using TypeDoc
Auto-generated interface for https://w3id.org/cwl/cwl#OutputParameter
-A documentation string for this object, or an array of strings which should be concatenated.
-The unique identifier for this object.
-A short, human-readable label of this object.
Generated using TypeDoc
Auto-generated interface for https://w3id.org/cwl/cwl#Parameter
Define an input or output parameter to a process.
-A documentation string for this object, or an array of strings which should be concatenated.
-The unique identifier for this object.
-A short, human-readable label of this object.
Generated using TypeDoc
The base executable type in CWL is the Process object defined by the
document. Note that the Process object is abstract and cannot be
directly executed.
A documentation string for this object, or an array of strings which should be concatenated.
-The unique identifier for this object.
-Defines the input parameters of the process. The process is ready to
run when all required input parameters are associated with concrete
values. Input parameters include a schema for each parameter which is
@@ -18,9 +18,9 @@
assigned a value of null (or the value of default for that
parameter, if provided) for the purposes of validation and evaluation
of expressions.
A short, human-readable label of this object.
-Defines the parameters representing the output of the process. May be used to generate and/or validate the output object.
Generated using TypeDoc
Auto-generated interface for https://w3id.org/cwl/salad#RecordField
A field of a record.
-A documentation string for this object, or an array of strings which should be concatenated.
-The name of the field
-The field type
Generated using TypeDoc
Auto-generated interface for https://w3id.org/cwl/salad#RecordSchema
-Defines the fields of the record.
-Must be record
Generated using TypeDoc
Auto-generated interface for https://galaxyproject.org/gxformat2/gxformat2common#ReferencesTool
-The tool ID used to run this step of the workflow (e.g. 'cat1' or 'toolshed.g2.bx.psu.edu/repos/nml/collapse_collections/collapse_dataset/4.0').
-The Galaxy Tool Shed repository that should be installed in order to use this tool.
-The tool version corresponding used to run this step of the workflow. For tool shed installed tools, the ID generally uniquely specifies a version and this field is optional.
Generated using TypeDoc
Auto-generated interface for https://galaxyproject.org/gxformat2/v19_09#Report
Definition of an invocation report for this workflow. Currently the only field is 'markdown'.
-Galaxy flavored Markdown to define an invocation report.
Generated using TypeDoc
Auto-generated interface for https://galaxyproject.org/gxformat2/v19_09#Sink
-Specifies one or more workflow parameters that will provide input to the underlying step parameter.
Generated using TypeDoc
Auto-generated interface for https://galaxyproject.org/gxformat2/gxformat2common#StepPosition
This field specifies the location of the step's node when rendered in the workflow editor.
-Relative horizontal position of the step's node when rendered in the workflow editor.
-Relative vertical position of the step's node when rendered in the workflow editor.
Generated using TypeDoc
Auto-generated interface for https://galaxyproject.org/gxformat2/gxformat2common#ToolShedRepository
-The revision of the tool shed repository this tool can be found in.
-The name of the tool shed repository this tool can be found in.
-The owner of the tool shed repository this tool can be found in.
-The URI of the tool shed containing the repository this tool can be found in - typically this should be toolshed.g2.bx.psu.edu.
Generated using TypeDoc
Auto-generated interface for https://galaxyproject.org/gxformat2/v19_09#WorkflowInputParameter
-Collection type (defaults to list if type is collection). Nested
collection types are separated with colons, e.g. list:list:paired.
The default value to use for this parameter if the parameter is missing
from the input object, or if the value of the parameter in the input
object is null. Default values are applied before evaluating expressions
(e.g. dependent valueFrom fields).
A documentation string for this object, or an array of strings which should be concatenated.
-Specify datatype extension for valid input datasets.
-The unique identifier for this object.
-A short, human-readable label of this object.
-If set to true, WorkflowInputParameter is not required to submit the workflow.
Specify valid types of data that may be assigned to this parameter.
Generated using TypeDoc
A documentation string for this object, or an array of strings which should be concatenated.
-The unique identifier for this object.
-A short, human-readable label of this object.
-Specifies workflow parameter that supply the value of to the output parameter.
-Specify valid types of data that may be assigned to this parameter.
Generated using TypeDoc
Auto-generated interface for https://galaxyproject.org/gxformat2/v19_09#WorkflowStepInput
TODO:
-The default value for this parameter to use if either there is no
source field, or the value produced by the source is null. The
default must be applied prior to scattering or evaluating valueFrom.
The unique identifier for this object.
-A short, human-readable label of this object.
-Specifies one or more workflow parameters that will provide input to the underlying step parameter.
Generated using TypeDoc
A unique identifier for this workflow output parameter. This is
the identifier to use in the source field of WorkflowStepInput
to connect the output value to downstream parameters.
The unique identifier for this object.
-Generated using TypeDoc
Generated using TypeDoc
state and tool_state fields.state can contained a typed map. Repeat values can be represented as YAML arrays. An alternative
to representing state this way is defining inputs with default values.
A documentation string for this object, or an array of strings which should be concatenated.
-During Galaxy export there may be some problem validating the tool state, tool used, etc.. that will be indicated by this field. The Galaxy user should be warned of these problems before the workflow can be used in Galaxy.
This field should not be used in human written Galaxy workflow files.
A typical problem is the referenced tool is not installed, this can be fixed by installed the tool and re-saving the workflow and then re-exporting it.
-The unique identifier for this object.
-Defines the input parameters of the workflow step. The process is ready to run when all required input parameters are associated with concrete values. Input parameters include a schema for each parameter which is used to validate the input object. It may also be used build a user interface for constructing the input object.
-A short, human-readable label of this object.
-Defines the parameters representing the output of the process. May be used to generate and/or validate the output object.
This can also be called 'outputs' for legacy reasons - but the resulting workflow document is not a valid instance of this schema.
-Specifies a subworkflow to run.
-Structured tool state.
-The tool ID used to run this step of the workflow (e.g. 'cat1' or 'toolshed.g2.bx.psu.edu/repos/nml/collapse_collections/collapse_dataset/4.0').
-The Galaxy Tool Shed repository that should be installed in order to use this tool.
-Unstructured tool state.
-The tool version corresponding used to run this step of the workflow. For tool shed installed tools, the ID generally uniquely specifies a version and this field is optional.
-Workflow step module's type (defaults to 'tool').
-UUID uniquely representing this element.
-If defined, only run the step when the expression evaluates to
true. If false the step is skipped. A skipped step
produces a null on each output.
Compute the shortname of a fully qualified identifier. See https://w3id.org/cwl/v1.2/SchemaSalad.html#Short_names.
Generated using TypeDoc
Auto-generated class implementation for https://w3id.org/cwl/salad#ArraySchema
-