chore: clarify 'unspecified' enum values #152
Open
Conversation
This file contains hidden or 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
|
The latest Buf updates on your PR. Results from workflow Lint / lint (pull_request).
|
vroldanbet
reviewed
Nov 18, 2025
|
|
||
| message PermissionChange { | ||
| enum Permissionship { | ||
| // Unspecified is an unused default value that should not be encountered in normal operation. |
Contributor
There was a problem hiding this comment.
Perhaps I would reframe it as "it's used to signal some edge case triggered in the server side, and that something went wrong, and that clients are expected to just error out"
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.
Fixes #151
Description
We have several enums where the 0 value is reserved as unused, and shouldn't be supplied or observed in the normal course of operation. We've gotten some questions about whether these enums need to be handled; adding this to the Buf documentation should clarify that.
Changes
UNSPECIFIEDfieldsTesting
Review.