-
Notifications
You must be signed in to change notification settings - Fork 2
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 support for specifying field name aliases #18
base: main
Are you sure you want to change the base?
Conversation
@@ -1,12 +1,15 @@ | |||
version: v2 | |||
modules: | |||
- path: internal/proto | |||
- path: proto | |||
name: buf.build/bufbuild/protoschema |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I need more explanation here before we add a public repo to the bufbuild org. What is this for?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The main use for this is protoyaml. It allows a field to be renamed without atomically updating all yaml files. Beyoned that, its a key missing feature for any usage of names in a serialization formats (e.g. json, yaml, flags, protobuf with optional ids, etc). For these formats, the main field name is preferred, and aliases support backwards compatibility for reads.
Using a new custom option: