docs: Document UNSPECIFIED enum values that are not returned #155
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
Add documentation to UNSPECIFIED enum values clarifying they are not valid values and won't be returned in normal operation. Fixes authzed#151 Signed-off-by: ivanauth <ivan@authzed.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Documents the various UNSPECIFIED enum values across the proto files to make it clear they're either rejected as input or won't show up in responses.
The
WILDCARD_OPTION_UNSPECIFIEDcase is a bit different - it's actually accepted and defaults to including wildcards, so documented it that way.Related to #154 which covers the permissionship enums specifically.
Fixes #151