component-schema
Component Schema Type
object (Component Schema)
Component Schema Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| id | string | Optional | cannot be null | Component Schema |
| type | string | Required | cannot be null | Component Schema |
| shortDescription | string | Optional | cannot be null | Component Schema |
| name | Merged | Optional | can be null | Component Schema |
| title | Merged | Optional | can be null | Component Schema |
| hint | string | Optional | cannot be null | Component Schema |
| options | object | Optional | cannot be null | Component Schema |
| schema | object | Optional | cannot be null | Component Schema |
| list | string | Optional | cannot be null | Component Schema |
| Additional Properties | Any | Optional | can be null |
id
Unique identifier for the component
id
-
is optional
-
Type:
string(Id) -
cannot be null
-
defined in: Component Schema
Id Type
string (Id)
id Constraints
UUID: the string must be a UUID, according to RFC 4122
type
Component type (TextField, RadioButtons, DateField, etc.)
type
-
is required
-
Type:
string(Type) -
cannot be null
-
defined in: Component Schema
Type
string (Type)
shortDescription
Brief description of the component purpose
shortDescription
-
is optional
-
Type:
string(Short Description) -
cannot be null
-
defined in: Component Schema
Short Description Type
string (Short Description)
name
The name value.
name
-
is optional
-
Type: any of the following:
arrayorbooleanornumberorobjectorstring(Name) -
can be null
-
defined in: Component Schema
Name Type
any of the following: array or boolean or number or object or string (Name)
one (and only one) of
title
The title value.
title
-
is optional
-
Type: any of the following:
arrayorbooleanornumberorobjectorstring(Title) -
can be null
-
defined in: Component Schema
Title Type
any of the following: array or boolean or number or object or string (Title)
one (and only one) of
hint
Additional guidance text displayed below the component title
hint
-
is optional
-
Type:
string(Hint) -
cannot be null
-
defined in: Component Schema
Hint Type
string (Hint)
options
Component-specific configuration options
options
-
is optional
-
Type:
object(Options) -
cannot be null
-
defined in: Component Schema
Options Type
object (Options)
options Default Value
The default value is:
{}schema
Validation rules for the component
schema
-
is optional
-
Type:
object(Schema) -
cannot be null
-
defined in: Component Schema
Schema Type
object (Schema)
schema Default Value
The default value is:
{}list
Reference to a predefined list of options for select components
list
-
is optional
-
Type:
string(List) -
cannot be null
-
defined in: Component Schema
List Type
string (List)
Additional Properties
Additional properties are allowed and do not have to follow a specific schema