Add support for enums avro schema doc #290
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Use the Description attribute for populating enums doc node i avro schema
dstelljes
approved these changes
Dec 18, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
The Avro schema spec supports
docon enums: https://avro.apache.org/docs/1.11.1/specification/#enumsThis PR uses the
System.ComponentModel.DescriptionAttributefor populating the enum doc node in Avro schemas.Why
As discussed here #131 .
The PR #219 implements this for record schemas.
This implements the same strategy for enums.
Note
We had a list of local customizations (documentation, null handling, enum default values, DateOnly, TimeOnly, NodaTime), and most of these have been fixed in the later releases. Brilliant! This PR is a contribution to get rid of one more :)