Parameter Schema Annotations¶
Note
See also UI Schema Annotations
On WorkflowTemplate
s (workflowtemplates.argoproj.io
) and ClusterWorkflowTemplate
s (clusterworkflowtemplates.argoproj.io
) annotations prefixed with workflows.diamond.ac.uk/parameter-schema
with a trailing dot separating the parameter name (e.g. metadata.annotations."workflows.diamond.ac.uk/parameter-schema.num-cores"
) are reserved for the specification of a parameter JSON Schema.
The Schema is used to enhance type checking in the WorkflowTemplate
and ClusterWorkflowTemplate
submission forms. If no Schema is supplied one will be automatically generated in which parameters will be assumed to be of type String
or Enum
depending on whether they contain the enum
declaration.