clement-brodu / PCTTools

Library to provide additional tools to PCT
MIT License
0 stars 1 forks source link

Add version number to JSON file #5

Closed gquerret closed 5 months ago

gquerret commented 5 months ago

In order to be able to deal with upgrades of the library, would it be possible to have a version attribute in the JSON output ?

{
  "version": 1,
  "classes": [
    {
      "name": "Microsoft.Win32.Registry",
      "baseTypes": [ "System.Object" ]
    }
}
clement-brodu commented 5 months ago

The version you need is more a "schema Version" than "library version", right ?

This version number must be incremented only in case of adding/removing/modifying something in the model ?

gquerret commented 5 months ago

Yes, schema version. This is to make sure the LS will correctly read data. File will be deleted in case of outdated schema, and notification sent to the user.

gquerret commented 5 months ago

Then schemaVersion attribute might be more relevant than version

clement-brodu commented 5 months ago

done,