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

Add ConfluentSchemaRegistry#compatibility_issues for debugging breaking changes #212

Merged
merged 1 commit into from
Oct 7, 2024

Conversation

catkins
Copy link
Contributor

@catkins catkins commented Oct 7, 2024

I've been using AvroTurf in CI to fail the build on incompatible changes. The Confluent Schema Registry support a verbose output for the compatibility API, so it would be excellent to be able to include that in my build failures.

verbose (boolean) – Add ?verbose=true at the end of this request to output the reason a schema fails the compatibility test, in cases where it fails. The default is false (the reason a schema fails compatibility test is not given).

https://docs.confluent.io/platform/current/schema-registry/develop/api.html#sr-api-compatibility

dasch
dasch previously approved these changes Oct 7, 2024
Copy link
Owner

@dasch dasch left a comment

Choose a reason for hiding this comment

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

@catkins! 😄

Looks great, but can you add an entry to the changelog?

@catkins
Copy link
Contributor Author

catkins commented Oct 7, 2024

Oh good call! I'll pop one in later on.

@catkins catkins force-pushed the catkins/verbose-compatibility branch from dcf7e7d to 5e15cea Compare October 7, 2024 08:54
@@ -2,6 +2,8 @@

## Unreleased

- Add `compatibility_issues` method to `ConfluentSchemaRegistry` to debug compatibility issues between a schema versions for a given subject (#212)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I popped it into this section, but let me know if you wanted me to add to a new v1.18.0 heading instead 😁

Copy link
Owner

Choose a reason for hiding this comment

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

This is perfect!

@catkins catkins requested a review from dasch October 7, 2024 08:55
@dasch dasch merged commit b21dae2 into dasch:master Oct 7, 2024
4 checks passed
@catkins
Copy link
Contributor Author

catkins commented Oct 7, 2024

Excellent, thanks @dasch! 👏

@catkins catkins deleted the catkins/verbose-compatibility branch October 8, 2024 01:01
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