chore: clarify 'unspecified' enum values

Author: tstirrat15

authzed/api/materialize/v0/watchpermissions.proto

@@ -66,6 +66,7 @@ message WatchPermissionsResponse {
 
 message PermissionChange {
   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;

authzed/api/materialize/v0/watchpermissionsets.proto

@@ -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;

authzed/api/v1/core.proto

@@ -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;
@@ -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;

authzed/api/v1/debug.proto

@@ -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;
@@ -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;

authzed/api/v1/permission_service.proto

@@ -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;
@@ -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
@@ -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;
@@ -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;
@@ -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;