-
Notifications
You must be signed in to change notification settings - Fork 424
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
feat: add version and description to definition #3437
feat: add version and description to definition #3437
Conversation
@yanivagman @rafaeldtinoco what do you think? If you agree, I'll add a |
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.
Yes, we can have all events versioned 1.0.0 at this point, and start following the semver semantics when updating the event:
- Major field is bumped whenever some data the event used to have was changed (e.g. a field was renamed or removed)
- Minor field is bumped whenever a non breaking change occurs (e.g. a new field was added to the event)
- Patch field is bumped whenever something is changed in the way the event works internally (e.g. some bug was fixed in the code)
17dfbeb
to
3c89467
Compare
3c89467
to
42d1bb4
Compare
42d1bb4
to
6bb5cb9
Compare
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.
LGTM
1. Explain what the PR does
This PR is part of the work to support a v1 for GRPC, and also the #2870, because the new event structure won't have metadata, and instead static data from the event will come from the definition, so users will be able to query the grpc endpoint to get a definition, but there is two important fields missing from the definition: