How do i define key value pairs object in json schema (the "correct" way) ?
i want to define this:
"id" : 99,
_info : {
"name" : "somename",
"href" : "someUrl"
}
Are any of the following two accurate?:
1)
{
"type": "object",
"name": "MyObj",
"properties": {
"id": {
"type": "integer"
},
"_info": {
"type": "array",
"items": {
"type": "object"
"properties": {
"key": {
"type": "string",
"description": "key"
},
"value": {
"type": "string",
"description": "the value"
}
}
}
}
}
}
2)
{
"type": "object",
"name": "MyObj",
"properties": {
"id": {
"type": "integer",
"_info": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "string values"
}
}
}
}
What is the correct way to get this accomplished and people will know what the schema is and the object will look like when serialized/deserialized?
In JSON an object is already a collection of key-value pairs. You don't need anything special in order to define it:
{
"_info":{"type":"object"}
}
From here you can add constraints.
Update 2019/09/10
As suggested in comments, if you want to restrict all properties to be of type string, you may do it this way:
{
"title": "Force every property to have a string value",
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"additionalProperties": {"type": "string"}
}
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With