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

Better breaking schema change descriptions for union type member removal #6125

Open
n1ru4l opened this issue Dec 16, 2024 · 0 comments
Open
Labels
good first issue Good for newcomers help wanted Extra attention is needed improvement registry

Comments

@n1ru4l
Copy link
Contributor

n1ru4l commented Dec 16, 2024

We already have some descriptions about why a breaking change is a breaking change. E.g. here in a schema version:
image

Some Hive users were confused about removing a union member being a breaking change.

Quick question about breaking change detection in Hive. I’ve removed an element from a union, no clients are currently requesting any fields on that type, but it shows as a breaking change. Is this expected?

We answered it the following way:

so the reason it is considered breaking is that it affects the __typename field. So from our system perspective, it's not safe to accept a deletion of a union member as it may affect the value of __typename and potentially break your GraphQL consumers (an example would be a React component that renders a child component based on the value of the __typename field, a feed that renders an Image post or a Text post).

Instead of people having to reach out to us, this information should be available within the changes UI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed improvement registry
Development

No branches or pull requests

2 participants