Skip to content

chore: clarify 'unspecified' enum values #152

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.

Sign up for GitHub

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

Open
tstirrat15 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: clarify 'unspecified' enum values #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions authzed/api/materialize/v0/watchpermissions.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ message WatchPermissionsResponse {

message PermissionChange {
enum Permissionship {
// Unspecified is an unused default value that should not be encountered in normal operation.
Copy link
Contributor

@vroldanbet vroldanbet Nov 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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"

PERMISSIONSHIP_UNSPECIFIED = 0;
PERMISSIONSHIP_NO_PERMISSION = 1;
PERMISSIONSHIP_HAS_PERMISSION = 2;
Expand Down
1 change: 1 addition & 0 deletions authzed/api/materialize/v0/watchpermissionsets.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ message LookupPermissionSetsResponse {

message PermissionSetChange {
enum SetOperation {
// Unspecified is an unused default value that should not be supplied in normal operation.
SET_OPERATION_UNSPECIFIED = 0;
SET_OPERATION_ADDED = 1;
SET_OPERATION_REMOVED = 2;
Expand Down
2 changes: 2 additions & 0 deletions authzed/api/v1/core.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ message Cursor {
// this operation will no-op.
message RelationshipUpdate {
enum Operation {
// Unspecified is an unused default value that should not be supplied in normal operation.
OPERATION_UNSPECIFIED = 0;
OPERATION_CREATE = 1;
OPERATION_TOUCH = 2;
Expand Down Expand Up @@ -202,6 +203,7 @@ message PermissionRelationshipTree {
// present in the first operand, and none of the other operands.
message AlgebraicSubjectSet {
enum Operation {
// Unspecified is an unused default value that should not be supplied in normal operation.
OPERATION_UNSPECIFIED = 0;
OPERATION_UNION = 1;
OPERATION_INTERSECTION = 2;
Expand Down
3 changes: 3 additions & 0 deletions authzed/api/v1/debug.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,14 @@ message DebugInformation {
// API call.
message CheckDebugTrace {
enum PermissionType {
// Unspecified is an unused default value that should not be encountered in normal operation.
PERMISSION_TYPE_UNSPECIFIED = 0;
PERMISSION_TYPE_RELATION = 1;
PERMISSION_TYPE_PERMISSION = 2;
}

enum Permissionship {
// Unspecified is an unused default value that should not be encountered in normal operation.
PERMISSIONSHIP_UNSPECIFIED = 0;
PERMISSIONSHIP_NO_PERMISSION = 1;
PERMISSIONSHIP_HAS_PERMISSION = 2;
Expand Down Expand Up @@ -130,6 +132,7 @@ message CheckDebugTrace {
// CaveatEvalInfo holds information about a caveat expression that was evaluated.
message CaveatEvalInfo {
enum Result {
// Unspecified is an unused default value that should not be encountered in normal operation.
RESULT_UNSPECIFIED = 0;

RESULT_UNEVALUATED = 1;
Expand Down
5 changes: 5 additions & 0 deletions authzed/api/v1/permission_service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,7 @@ message ReadRelationshipsResponse {
// relationships that match the filter.
message Precondition {
enum Operation {
// Unspecified is an unused default value that not be supplied in normal operation.
OPERATION_UNSPECIFIED = 0;
OPERATION_MUST_NOT_MATCH = 1;
OPERATION_MUST_MATCH = 2;
Expand Down Expand Up @@ -444,6 +445,7 @@ message DeleteRelationshipsRequest {

message DeleteRelationshipsResponse {
enum DeletionProgress {
// Unspecified is an unused default value that should not be encountered in normal operation.
DELETION_PROGRESS_UNSPECIFIED = 0;

// DELETION_PROGRESS_COMPLETE indicates that all remaining relationships matching the filter
Expand Down Expand Up @@ -511,6 +513,7 @@ message CheckPermissionRequest {

message CheckPermissionResponse {
enum Permissionship {
// Unspecified is an unused default value that should not be encountered in normal operation.
PERMISSIONSHIP_UNSPECIFIED = 0;
PERMISSIONSHIP_NO_PERMISSION = 1;
PERMISSIONSHIP_HAS_PERMISSION = 2;
Expand Down Expand Up @@ -742,6 +745,7 @@ message LookupResourcesRequest {

// LookupPermissionship represents whether a Lookup response was partially evaluated or not
enum LookupPermissionship {
// Unspecified is an unused default value that should not be encountered in normal operation.
LOOKUP_PERMISSIONSHIP_UNSPECIFIED = 0;
LOOKUP_PERMISSIONSHIP_HAS_PERMISSION = 1;
LOOKUP_PERMISSIONSHIP_CONDITIONAL_PERMISSION = 2;
Expand Down Expand Up @@ -784,6 +788,7 @@ message LookupResourcesResponse {
// which the subject exists, streaming back the IDs of those subjects.
message LookupSubjectsRequest {
enum WildcardOption {
// Unspecified is an unused default value that not be supplied in normal operation.
WILDCARD_OPTION_UNSPECIFIED = 0;
WILDCARD_OPTION_INCLUDE_WILDCARDS = 1;
WILDCARD_OPTION_EXCLUDE_WILDCARDS = 2;
Expand Down