Document permissionship enum values #153
Closed
+60
−3
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
Added documentation explaining what each Permissionship value means and when it's returned. The CONDITIONAL_PERMISSION docs point to the specific fields where you can find caveat details for each context (partial_caveat_info in CheckPermissionResponse, caveat_evaluation_info in CheckDebugTrace, etc). Also documented LookupPermissionship and regenerated the swagger docs.
Author
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
Add documentation comments to permissionship enum values explaining their meaning and when they are returned during normal API operation.
Fixes #151
Changes
PERMISSIONSHIP_UNSPECIFIED,PERMISSIONSHIP_NO_PERMISSION,PERMISSIONSHIP_HAS_PERMISSION, andPERMISSIONSHIP_CONDITIONAL_PERMISSIONin:authzed/api/v1/permission_service.proto(CheckPermissionResponse.Permissionship)authzed/api/v1/debug.proto(CheckDebugTrace.Permissionship)authzed/api/materialize/v0/watchpermissions.proto(PermissionChange.Permissionship)LOOKUP_PERMISSIONSHIP_*values inauthzed/api/v1/permission_service.protodocs/apidocs.swagger.jsonwith the new documentation