Component Schema V2 Type

object (Component Schema V2)

Component Schema V2 Properties

type

Component type (TextField, RadioButtons, DateField, etc.)

type

• is required

• Type: string (Type)

• cannot be null

• defined in: Component Schema V2

Type

string (Type)

shortDescription

Brief description of the component purpose

shortDescription

• is optional

• Type: string (Short Description)

• cannot be null

• defined in: Component Schema V2

Short Description Type

string (Short Description)

name

The name value.

name

• is optional

• Type: any of the following: array or boolean or number or object or string (Name)

• can be null

• defined in: Component Schema V2

Name Type

any of the following: array or boolean or number or object or string (Name)

one (and only one) of

• Display Component Name

• Input Component Name

title

The title value.

title

• is optional

• Type: any of the following: array or boolean or number or object or string (Title)

• can be null

• defined in: Component Schema V2

Title Type

any of the following: array or boolean or number or object or string (Title)

one (and only one) of

• Display Component Title

• Input Component Title

hint

Additional guidance text displayed below the component title

hint

• is optional

• Type: string (Hint)

• cannot be null

• defined in: Component Schema V2

Hint Type

string (Hint)

options

Component-specific configuration options

options

• is optional

• Type: object (Options)

• cannot be null

• defined in: Component Schema V2

Options Type

object (Options)

options Default Value

The default value is:

Copy
{}

schema

Validation rules for the component

schema

• is optional

• Type: object (Schema)

• cannot be null

• defined in: Component Schema V2

Schema Type

object (Schema)

schema Default Value

The default value is:

Copy
{}

id

Unique identifier for the component

id

• is optional

• Type: string (Id)

• cannot be null

• defined in: Component Schema V2

Id Type

string (Id)

id Constraints

UUID: the string must be a UUID, according to RFC 4122

list

List id reference to a predefined list of options for select components

list

• is optional

• Type: string (List)

• cannot be null

• defined in: Component Schema V2

List Type

string (List)

list Constraints

constant: the value of this property must be equal to:

Copy
{
  "ref": {
    "path": [
      "lists"
    ],
    "ancestor": "root",
    "in": true
  }
}

Additional Properties

Additional properties are allowed and do not have to follow a specific schema