Skip to content

docs: Document UNSPECIFIED enum values that are not returned #155

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
ivanauth wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Document UNSPECIFIED enum values that are not returned #155

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
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 {
// OPERATION_UNSPECIFIED is not a valid operation and will be rejected.
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 {
// OPERATION_UNSPECIFIED is not a valid operation and will not be returned.
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 {
// PERMISSION_TYPE_UNSPECIFIED is not a valid type and will not be returned.
PERMISSION_TYPE_UNSPECIFIED = 0;
PERMISSION_TYPE_RELATION = 1;
PERMISSION_TYPE_PERMISSION = 2;
}

enum Permissionship {
// PERMISSIONSHIP_UNSPECIFIED is not a valid result and will not be returned.
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 {
// RESULT_UNSPECIFIED is not a valid result and will not be returned.
RESULT_UNSPECIFIED = 0;

RESULT_UNEVALUATED = 1;
Expand Down
3 changes: 3 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 {
// OPERATION_UNSPECIFIED is not a valid operation and will be rejected.
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 {
// DELETION_PROGRESS_UNSPECIFIED is not a valid status and will not be returned.
DELETION_PROGRESS_UNSPECIFIED = 0;

// DELETION_PROGRESS_COMPLETE indicates that all remaining relationships matching the filter
Expand Down Expand Up @@ -784,6 +786,7 @@ message LookupResourcesResponse {
// which the subject exists, streaming back the IDs of those subjects.
message LookupSubjectsRequest {
enum WildcardOption {
// WILDCARD_OPTION_UNSPECIFIED is the default and is equivalent to WILDCARD_OPTION_INCLUDE_WILDCARDS.
WILDCARD_OPTION_UNSPECIFIED = 0;
WILDCARD_OPTION_INCLUDE_WILDCARDS = 1;
WILDCARD_OPTION_EXCLUDE_WILDCARDS = 2;
Expand Down