Correct Way to Define Array of Enums in Json Schema
I Want to Describe with Json Schema Array, Which Should Consist of Zero or More Predefined Values. to Make It Simple, Let's Have These Possible Values: One...
I want to describe with JSON schema array, which should consist of zero or more predefined values. To make it simple, let's have these possible values: one, two and three.
Correct arrays (should pass validation):
[]
["one", "one"]
["one", "three"]
Incorrect:
["four"]
Now, I know the "enum" property should be used, but I can't find relevant information where to put it.
Option A (under "items"):
{
"type": "array",
"items": {
"type": "string",
"enum": ["one", "two", "three"]
}
}
Option B:
{
"type": "array",
"items": {
"type": "string"
},
"enum": ["one", "two", "three"]
}
2 Answers
Option A is correct and satisfy your requirements.
{
"type": "array",
"items": {
"type": "string",
"enum": ["one", "two", "three"]
}
}
According to json-schema documentation, the enumerated values of an array must be included in the "items" field:
{
"type": "array",
"items": {
"type": "string",
"enum": ["one", "two", "three"]
}
}
If you have an array that can hold e.g. items of different type, then your schema should look like the one below:
{
"type": "array",
"items": [
{
"type": "string",
"enum": ["one", "two", "three"]
},
{
"type": "integer",
"enum": [1, 2, 3]
}
]
}
David Miller brings 15 years of experience in global economics, personal finance strategy, and market dynamics. He specializes in turning complex economic trends into actionable insights for everyday readers.
