JSON Schema for Schema Plugins
You define the schema plugin fields that appear in extendedFields
with a subset of JSON schema. The plugin schema has some restrictions and additions set by Wix, but the general syntax, supported types, and keywords are mostly the same as JSON schema. Wix supports JSON schema version 2019-09 or higher.
General restrictions
As with a normal JSON schema, to define your plugin fields, you’ll add them as property keys to the properties
object. Keep in mind the following restrictions on the schema:
-
Plugin schemas can't contain more than 256 properties.
-
The maximum length of a property key is 64 characters.
-
Property keys must start with a letter and can contain only letters, numbers, and underscores.
-
A schema plugin can store a maximum of 10 KB of data per object. This means that each site that installs your app can store up to 10 KB of data for each object that your app extends.
For example, if your app extends both the booking and checkout objects, it has a total of 20 KB of database storage. It can use up to 10 KB for the Booking object schema, and up to 10 KB for the Checkout object schema.
A schema’s maximum size is calculated based on the field types defined in the schema, including the maximum lengths of all strings and the maximum items of all arrays.
Schema properties
Root-level properties
Property | Data Type | Description |
---|---|---|
type | string | Required. Top-level key defining the type of properties . Must be "object" . |
properties | object | Required. Top-level object containing the schema plugin fields defined as key-object pairs. The table below explains the structure of the properties object. |
The properties
object
Property | Data Type | Description |
---|---|---|
type | string | Required. Second-level key defining a field’s expected data type. Supported values: "string" , "number" , "integer" , "boolean" , "array" , "object" .Defined inside the object value of each property. |
x-wix-permissions | object | Required. Defines a field’s read and write permissions. See Defining field permissions for more information. |
x-wix-archived | boolean | Used to archive fields. See Archiving fields for more information. |
items | object | Required if type is "array" . Omitted for other data types. Object that contains the type of data that the array contains. See array for more information. |
maxItems | number | Required if type is "array" .Defines the maximum number of items the array can hold. See array for more information. |
properties | object | Required if type is "object" . Omitted for other data types. Object containing nested schema plugin fields. It accepts the same data as the 1st-level properties object and may contain strings, numbers, integers, booleans, or nested objects. |
format | string | Used only in string fields. Defines a specific format for a string field, for example a date or a time. See string for more information. |
maxLength | number | Required if type is "string" .Defines the maximum number of characters the field accepts. See string for more information. |
minLength | number | Used only in string fields. Defines the minimum number of characters the field accepts. See string for more information. |
maximum | number | Used only in number or integer fields. Defines the maximum value the field accepts. See number and integer for more information. |
minimum | number | Used only in number or integer fields. Defines the minimum value the field accepts. See number and integer for more information. |
exclusiveMaximum | number | Used only in number or integer fields. Defines the maximum value the field accepts, excluding the defined value. See number and integer for more information. |
exclusiveMinimum | number | Used only in number or integer fields. Defines the minimum value the field accepts, excluding the defined value. See number and integer for more information. |
Supported types
The schema plugin supports all the basic JSON schema types, with some restrictions. These restrictions (if any) are detailed below for each type.
string
Size: Varies. Each character is 1 byte.
Restrictions:
- Length: Strings must be between 1 and 10,000 characters long.
- The maximum length of a string field must be defined using the
maxLength
keyword.
Supported formats:
The JSON schema supports the following format values:
-
color-hex
-
currency
-
date-time
-
date
-
guid
-
hostname
-
language
-
time
-
uri
-
email
: A custom Wix value indicating a valid email address. The maximum length of an email address is 254 characters. -
phone
: A custom Wix value indicating a valid phone number. -
single-line
: The valuesingle-line
indicates a field that can only contain a single line of text. The string must end with a newline character (\n
).Note: By default, a string field is considered multi-line text. If it is defined as single-line, the format can be removed later. However, if a string is created as multi-line text, the format can't be changed later to single-line, because this is a breaking change.
number
Size: 8 bytes
Restrictions:
- Minimum value: -253 + 1.
- Maximum value: 253 + 1.
integer
Size: 4 bytes
Restrictions:
- Minimum value: -253 + 1.
- Maximum value: 253 + 1.
object
Size: Varies
Restrictions:
- An object must contain a
properties
field that defines its properties. - The object’s properties must follow the restrictions of the other types listed here.
- There is a maximum of 10 nesting levels for an object.
array
Size: An array’s size is determined by the type it contains and its max length. For example, given the following property:
1
The array contains a maximum of 20 integers. Therefore its total size is:
4 bytes/integer × 20 integers = 80 bytes.
Now consider an array of strings:
1
The array contains a maximum of 10 strings, each of which can have a maximum length of 10 characters. Since 1 character = 1 byte, we can calculate the array’s total size like this:
(10 characters × 1 byte/character) × 10 = 100 bytes.
Restrictions:
- An array must contain an
items
key that defines the type of items in the array. - The items in the array must follow all the restrictions of the other types listed here.
- An array can contain a maximum of 100 items. The maximum number of items must be defined using the
maxItems
keyword. - All the items in an array must be the same type.
- Arrays support items of type
string
,number
,integer
,boolean
, andobject
.
boolean
Size: 1 byte
Restrictions: None
Supported keywords
The following global JSON schema keywords are supported:
The following global keywords are not supported:
required
$defs
$ref
readOnly
writeOnly
Defining field permissions
For each field you add to the plugin schema, you need to define permissions. These permissions tell your app who can read and write to the field.
The permissions you define in the schema assume that the extended entity allows apps to read and write it. If an entity does not allow apps read and write permission, then no group will be able to read and write to the entity, no matter what permissions are defined.
There are four supported permission values:
owning-app
: The app that defines the extended field.apps
: Other apps installed on the same site as the owning app.users
: Collaborators of sites that have the owning app installed.users-of-users
: Visitors of sites that have the owning app installed.
Note:
If you enable users-of-users
permissions for reading or writing an extended field, also enable the users
permissions. Otherwise, users won't be able to read or write the extended field data created by their site visitors.
To add permissions to a field, include the Wix-specific x-wix-permissions
keyword in the field object. In the value, include two arrays: one specifying the read permissions, and the second specifying the write permissions.
For example:
1
When you create a schema plugin in the Dev center, owning-app
read and write permissions are added by default. Therefore, you don’t need to explicitly define them in x-wix-permissions
.
Editing the schema
Once you’ve saved the schema, there are limits on how you can edit it. You can only make non-breaking changes to the schema. Examples of non-breaking changes include:
- Adding a new field.
- Adding or removing permissions in an existing field.
- Increasing a field’s max limit (for example, the
maxLength
value in a string field). - Decreasing a field’s min limit (for example, the value of
minimum
in a number or integer field). - Removing a field’s min or max limit entirely.
- Changing settings like
title
,description
andplaceholder
.
Examples of breaking changes are:
- Removing a field.
- Decreasing a field’s max limit.
- Increasing a field’s min limit.
- Adding a max or min limit to a field that didn’t have one before.
Archiving schema fields
You can’t delete fields from your schema, but you can archive them using the x-wix-archived
keyword. As with permissions, add x-wix-archived
to the field that you want to archive, and set it to true
.
For example:
1
The archived field remains in the database, so you cannot reuse its key for another field. During read operations, it is filtered out, and during write operations the field is ignored. A field that is archived still takes up the same amount of space in memory and therefore counts towards the 10 KB total your schema plugin can take up.
All the schema types support archiving. If the archived field has nested fields, the nested fields are also archived. To restore an archived extended field, change the value of x-wix-archived
to false
or remove it from the schema.
JSON validation errors
If your JSON schema doesn't align with the restrictions detailed above, you'll receive a validation error. Here are a few common errors and what they mean:
Error | What it means | Example that can cause this error |
---|---|---|
MANDATORY_FIELD_MISSING | A mandatory keyword is missing | A string field is missing the maxLength keyword. |
UNKNOWN_KEYWORD_AT_THIS_LEVEL | You added a keyword in the wrong place. | You added x-wix-permissions in the items object of an array field. |
EXCEEDED_STORED_DATA_SIZE | Your schema exceeds the 10 KB limit. | You try to increase maxLength in your string fields, but there's not enough storage remaining to support longer strings. |
Example schema plugin
Here is an example of a schema plugin that defines firstName
, lastName
, and age
fields. This is what the final schema looks like in the JSON Editor:
1