Property

Property

Properties

JSON Example

{
    "$dynamicDefault": "string",
    "$dynamicEnum": "string",
    "const": {},
    "default": {},
    "description": "string",
    "encrypted": false,
    "enum": [
        {}
    ],
    "format": "string",
    "items": "Property Object",
    "maxItems": 0,
    "maxLength": 0,
    "maximum": 0,
    "minItems": 0,
    "minLength": 0,
    "minimum": 0,
    "oneOf": [
        "Property Object"
    ],
    "pattern": "string",
    "properties": {
        "properties": "Property Object"
    },
    "readOnly": false,
    "title": "string",
    "type": "string"
}

string

$dynamicDefault

Optional

Path that can be used to retrieve single permissible default value

string

$dynamicEnum

Optional

Path that can be used to retrieve permissible values

object

const

Optional

Constant value for the property

object

default

Optional

Default value for the property

string

description

Optional

Property description

boolean

encrypted

Optional

Flag indicating if property is encrypted

array of object

enum

Optional

Restrict a value to a fixed set of values for the property

string

format

Optional

The expected (and pre-defined) format to be used for string validations. Supported format values include: date-time, email, ip-address, alphanumeric, phone, etc.

Property

items

Optional

Properties

integer As int64 As int64

maxItems

Optional

Maximum number of items for the property

integer As int32 As int32

maxLength

Optional

String instance is validated against this keyword for its maximum length

integer As int64 As int64

maximum

Optional

Maximum value for the property

integer As int64 As int64

minItems

Optional

Minimum number of items for the property

integer As int32 As int32

minLength

Optional

String instance is validated against this keyword for its minimum length

integer As int64 As int64

minimum

Optional

Minimum value for the property

array of Property

oneOf

Optional

Ensures the given data is valid against only one of the specified schemas

string

pattern

Optional

Regular expression to express constraint for the property

object

properties

Optional

Properties within the property

boolean

readOnly

Optional

Flag indicating if property is read only

string

title

Optional

Property title

string

type

Optional

Property type should be among valid types (number, integer, string, array, boolean, object)

Property Of

Property