Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extract JSON compatibility checking code into a separate module #1214

Closed
blacktooth opened this issue Feb 12, 2021 · 5 comments
Closed

Extract JSON compatibility checking code into a separate module #1214

blacktooth opened this issue Feb 12, 2021 · 5 comments
Assignees

Comments

@blacktooth
Copy link
Contributor

blacktooth commented Feb 12, 2021

One of our use-cases require the JSON compatibility checking feature of apicurio-registry. We want to know if it's possible to extract the JSON compatibility checker and related classes into a separately buildable module.

We cannot depend on the whole apicurio-registry repository as it would bring-in lot of dependencies like rest client, Protobuf, Avro, etc which we don't need.

Can we contribute this change?

@EricWittmann
Copy link
Member

I don't think this would be difficult. In fact, we have our own goal of relocating the JSON compatibility checking from apicurio-registry repository into the apicurio-data-models repository. But that will require a rewrite of the functionality and a new JSON Schema data model in apicurio-data-models, so that won't happen too soon. Before that happens, I don't think it would be a big problem isolating the current functionality into a separate module for re-use.

@jsenko what do you think?

@blacktooth
Copy link
Contributor Author

blacktooth commented Feb 16, 2021

Since there is no standard for JSON compatibility checking (AKAIK), are you willing to publish the work done in this repository as specification for JSON schema evolution? We can think of creating a separate repository something like apicurio/json-schema-compatibility-checker.

I am open to contribute this.

This is still an open item on json schema org repo, json-schema-org/json-schema-vocabularies#5

@jsenko
Copy link
Member

jsenko commented Feb 17, 2021

hi, I agree that moving it into a separate module should be OK for the short term. For the long term, we would like to relocate it into apicurio-data-models, as Eric mentioned.

@blacktooth
Copy link
Contributor Author

blacktooth commented Feb 20, 2021

Thanks for confirming! I created a PR to refactor the code to modularize this.

@EricWittmann
Copy link
Member

Fixed in #1302

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants