How to indicate dynamic additions support in json schema?

Question

Just started with jsonschema. I want to describe a collection of objects for a property where the key may not be known a priori.

Here is my starting point:

                "tx_properties": {
                    "type": "object",
                    "anyOf": [
                        {
                            "required": [
                                "original_msg"
                            ]
                        }
                    ],
                    "properties": {
                        "original_msg": {
                            "type": "string"
                        }
                    }
                }
            }

I want to be able to validate the additions of more properties for tx_properties that may have different types but are not known at schema definition time.

For example I might have, in json:

"tx_properties": {
    "original_msg": "foo",
    "something_else": "bar",
    "or_something_numeric": 172,
    "or_even_deeper_things": {
        "fungible": false,
    }
}

As a n00b I'm a bit stuck on how to accomplish this. The use of anyOne is what I thought I needed at least in the final solution.

By default you can add anything to an object if, only when you specify additionalProperties: false this is not true. Maybe I'm misunderstanding — Evert
– Evert, Commented Sep 19, 2021 at 11:10
@Evert are you saying that with the schema I've described at the top of the message, if I validate against the data example I've also shown... it will validate OK? — Frank C.
– Frank C., Commented Sep 19, 2021 at 13:23
@Evert Not yet... I need to get the test data generator going but by EOD I should — Frank C.
– Frank C., Commented Sep 19, 2021 at 19:33
@Evert - Works, thanks for the insight and Ether for expanding and including the link. — Frank C.
– Frank C., Commented Sep 19, 2021 at 20:39

Ether · Accepted Answer · 2021-09-19 16:02:02Z

1

As @Evert said, "additionalProperties": false can be used to indicate that no other properties other than those listed in properties keywords (and patternProperties) are permitted. If additionalProperties is omitted, the behaviour is as if the schema said "additionalProperties": true (that is, additional properties are permitted).

Also note that the value at additionalProperties doesn't have to be a boolean: it can be a subschema itself, to allow you to conditionally allow for additional properties depending on their value(s).

Reference: https://json-schema.org/understanding-json-schema/reference/object.html#additional-properties

answered Sep 19, 2021 at 16:02

Ether

54.2k13 gold badges91 silver badges162 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to indicate dynamic additions support in json schema?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related