Replace jsonschema with pydantic about traefik-k8s-operator HOT 5 OPEN

I'm thinking we'd use the datamodel-code-generator, probably as part of the CI of the relation interfaces repo itself, and that users then would be able to download the pydantic model straight from github and use it in their projects.

from traefik-k8s-operator.

I don't disagree here, but we should be cautious merging, as it will essentially be a breaking change due to changing the external requirements of the lib :) I'm interested to see the diff in the code though.

from traefik-k8s-operator.

I don't disagree here, but we should be cautious merging, as it will essentially be a breaking change due to changing the external requirements of the lib :) I'm interested to see the diff in the code though.

Agreed. Given that @PietroPasotti is working on v1 of the libs (#63), which essentially will be incompatible regardless, it feels like it could be a good time to do both these changes at the same time to not have break the compatibility twice. :)

from traefik-k8s-operator.

I like the idea! I was thinking to combine this with #38
And also in reference to canonical/charm-relation-interfaces#7 I'm thinking this would definitely settle the yaml/json score (pydantic has builtin json converters I believe) So dumping data is as easy as model.json().

I'm thinking about the last line you added; what do you reckon would the user story look like?

• I want to implement an ingress Requirer.
• I go to charm-relation-interfaces, grab the jsonschema spec
• run the spec through our lib-provided tool jsonschema_to_pydantic /path/to/jsonschema/file.json, copy the result into the new requirer file.
• Profit?

from traefik-k8s-operator.

@jnsgruk @simskij see #66

from traefik-k8s-operator.