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

Derive {From,To}JSON for EntityDef #1540

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

evanrelf
Copy link

@evanrelf evanrelf commented Jul 9, 2024

...and its dependencies.

Motivated by some orphan instances we have at $WORK to dump our persistent entities (i.e. our database schema) to JSON for manipulation elsewhere.

...and its dependencies.

Motivated by some orphan instances we have at `$WORK` to dump our
`persistent` entities (i.e. our database schema) to JSON for
manipulation elsewhere.
@evanrelf
Copy link
Author

evanrelf commented Jul 9, 2024

Not sure if you want @since annotations on Generic, FromJSON, and ToJSON, so I've omitted them for now.

@evanrelf
Copy link
Author

evanrelf commented Jul 9, 2024

Not sure that upstream wants this, but I'm interested in building stuff with this at work, so maybe others would find it useful.

@parsonsmatt parsonsmatt self-requested a review July 10, 2024 01:55
Copy link
Collaborator

@parsonsmatt parsonsmatt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a little hesitant to incorporate this, because it sort of makes the JSON representation part of the public API.

Would you mind adding @since comments to the JSON instances with a comment saying that a breaking change to the JSON representation may not be considered a breaking change for PVP reasons?

@@ -1,5 +1,10 @@
# Changelog for persistent

## 2.14.7.0 (unreleased)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## 2.14.7.0 (unreleased)
## 2.14.7.0

I can release this asap

@evanrelf
Copy link
Author

I'm a little hesitant to incorporate this, because it sort of makes the JSON representation part of the public API.

Yeah, I figured it wouldn't be a 100% uncontroversial change! So I don't mean to push for this strongly if you or other maintainers feel it's not the right move.

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

Successfully merging this pull request may close these issues.

2 participants