messages icon indicating copy to clipboard operation
messages copied to clipboard

`$schema` in messages

Open ciaranmcnulty opened this issue 3 years ago • 3 comments

We could start to add $schema URLs to generated JSON

For now this would just suffice to make them more comprehensible/validatable, but going forwards it could allow a schema versioning mechanism

ciaranmcnulty avatar Nov 16 '22 13:11 ciaranmcnulty

We'd have to solve a bootstrapping problemen. We don't know what the version of the schema is until we make a release.

And while we could generate all the code when we make a release, we intentionally don't do that to avoid making the build processs complicated.

mpkorstanje avatar Nov 19 '22 11:11 mpkorstanje

Another problem I imagine would be that the messages should be light weight. Adding a url to every envelop is going to increase the size of the ndjson report.

mpkorstanje avatar Nov 19 '22 11:11 mpkorstanje

It seems to me the schema version could/should be different to the messages version? Or at least we should only increment the schema's major version when we break backwards compatibility in the 'json schema' sense?

ciaranmcnulty avatar Jan 05 '23 17:01 ciaranmcnulty