list-schema
List Schema Type
object (List Schema)
List Schema Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| id | string | Optional | cannot be null | List Schema |
| name | string | Required | cannot be null | List Schema |
| title | string | Required | cannot be null | List Schema |
| type | string | Required | cannot be null | List Schema |
| items | Merged | Optional | can be null | List Schema |
id
Unique identifier for the list
id
-
is optional
-
Type:
string(Id) -
cannot be null
-
defined in: List Schema
Id Type
string (Id)
id Constraints
UUID: the string must be a UUID, according to RFC 4122
name
Name used to reference this list from components
name
-
is required
-
Type:
string(Name) -
cannot be null
-
defined in: List Schema
Name Type
string (Name)
title
Human-readable title for the list
title
-
is required
-
Type:
string(Title) -
cannot be null
-
defined in: List Schema
Title Type
string (Title)
type
Data type for list values (string or number)
type
-
is required
-
Type:
string(Type) -
cannot be null
-
defined in: List Schema
Type
string (Type)
type Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"string" | |
"number" |
items
The items value.
items
-
is optional
-
Type: any of the following:
arrayorbooleanornumberorobjectorstring(Items) -
can be null
-
defined in: List Schema
Items Type
any of the following: array or boolean or number or object or string (Items)
one (and only one) of