SAP / abap-file-formats

File formats that define and specify the file representation for ABAP development objects
MIT License
58 stars 55 forks source link

JSON schema: Change property `additionalProperties` to `true` #248

Closed schneidermic0 closed 2 years ago

schneidermic0 commented 2 years ago

The property additionalProperties in our JSON schema is set to false, currently. Do to this setting it is incompatible to add or remove non-mandatory fields.

As mentioned in #105, adding and removing non-mandatory fields would be compatible if the property additionalProperties is set to true. With this we won't have to increase the format version if we add or remove new non-mandatory fields.

What do you think?

See also:

albertmink commented 2 years ago

Yes, no need to restrict ourselves here. Maybe just drop the additionalProperties at all, since the default is true, see http://json-schema.org/understanding-json-schema/reference/object.html#additional-properties

schneidermic0 commented 2 years ago

We discussed this topic.

We have decided to remove the field additionalProperties from our JSON schema files.

Following tasks are necessary to change this:

schneidermic0 commented 2 years ago

Today, we had a discussion with the team. We tend to keep the property additionalProperties with value false. With this we can avoid that random fields are added to the data. On the other hand, this means we have to consider the removal of fields in general as an incompatible change. But I think this would be fine.

Any objections?

If there are no objections, I'll prepare a change to update the documentation accordingly.

schneidermic0 commented 2 years ago

We decided to keep the field additionalProperties. Therefore, I close this issue.