Edit on GitHub

Selector Schema

A schema that is used to validate a part of Laboperator workflow templates.

The schema of a selector. The options defined will be available for selection in the substep during a workflow run. A selector can be customized with different layouts, currently list or cards. They support both multi- and single-selection. By overwriting the default behaviors they can be completely customized.

Selector Schema
layout
string
one of: cards list
default: list

The layout of the selector. Supported layouts are list and cards. You can change layouts during selection on the workflow run without affecting the value defined in the template.

result
reference
Member Name
Define the field that will receive the value of the selected option.
title
string
default: Selection
The title of the selector.
description
string
default: Select one of the options below.

The description of the selector. Add any fancy description you want, we support Markdown!

multiSelection
boolean
default: false
Defines if the selector allows the selection of more than one option.
skipBehaviors
boolean
default: false

Defines if the default behaviors of the substep should be skipped or not. The default behavior of a selector is to set the value of the selected option(s) on the result field and complete the substep. If you set this option to true, you need to add behaviors, either in the substep or step level, and one of the actions must be the SET_FIELD.

optionsrequired
reference or reference or object
one of
  • Member Name
  • Selector Options
  • object
reference
Member Name

A member name that is used as a reference elsewhere. Allowed characters are lower "a" to "z", capital "A" to "Z", "0" to "9" and "-" , "_". We recommend to consistently use either lowerCamelCase or kebab-case. While snake_case is allowed, it has a chance of name collisions with internal values.

Where is this used?
Other schemas that have a reference ($ref) to this schema.