Skip to content
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

ListUsers API protobuf definitions #140

Merged
merged 15 commits into from
Mar 9, 2024
Merged

ListUsers API protobuf definitions #140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
efd2476
Initial spike
willvedd Jan 17, 2024
e865b12
Getting to baseline working condition
willvedd Mar 7, 2024
0f989b5
Merging with main
willvedd Mar 7, 2024
fd9e19d
Addressing build failure
willvedd Mar 7, 2024
ef4f351
Fixing typo
willvedd Mar 7, 2024
18a3b9b
Correcting listusers request
willvedd Mar 8, 2024
6b1fb8f
Adding listusers response
willvedd Mar 8, 2024
319380e
Removing ID example
willvedd Mar 8, 2024
7ef50ff
Removing ID example
willvedd Mar 8, 2024
1fda870
Applying formatting
willvedd Mar 8, 2024
d12a3df
Updating swagger too
willvedd Mar 8, 2024
b7d77ab
Updating w/ oneof
willvedd Mar 8, 2024
c98ffc5
Update openfga/v1/openfga_service.proto
willvedd Mar 8, 2024
9bcca04
Regenerating
willvedd Mar 8, 2024
1bac6ce
Adding ListUsersFilter length contraint
willvedd Mar 8, 2024
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
176 changes: 176 additions & 0 deletions docs/openapiv2/apidocs.swagger.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

115 changes: 115 additions & 0 deletions openfga/v1/openfga_service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -672,6 +672,20 @@ service OpenFGAService {
"The objects given will not be sorted, and therefore two identical calls can give a given different set of objects."
};
}

rpc ListUsers(ListUsersRequest) returns (ListUsersResponse) {
option (google.api.http) = {
post: "/stores/{store_id}/list-users",
body: "*"
};

option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "List all users of the given type that the object has a relation with"
tags: ["Relationship Queries"]
operation_id: "ListUsers"
description: ""
};
}
}

message ListObjectsRequest {
Expand Down Expand Up @@ -731,6 +745,107 @@ message ListObjectsResponse {
];
}

message ListUsersRequest {
string store_id = 1 [
json_name = "store_id",
(validate.rules).string = {pattern: "^[ABCDEFGHJKMNPQRSTVWXYZ0-9]{26}$"},
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"01YCP46JKYM8FJCQ37NMBYHE5X\""}
];

string authorization_model_id = 2 [
json_name = "authorization_model_id",
(validate.rules).string = {
pattern: "^[ABCDEFGHJKMNPQRSTVWXYZ0-9]{26}$",
ignore_empty: true
},
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"01G5JAVJ41T49E9TT3SKVS7X1J\""}
];

Object object = 3 [
json_name = "object",
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"document:example\""},
(google.api.field_behavior) = REQUIRED
];

string relation = 4 [
(validate.rules).string = {pattern: "^[^:#@\\s]{1,50}$"},
(google.api.field_behavior) = REQUIRED,
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"reader\""}
];

repeated ListUsersFilter user_filters = 5 [
json_name = "user_filters",
(google.api.field_behavior) = REQUIRED,
(validate.rules).repeated = {
min_items: 1,
max_items: 1
},
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "[{\"type\": \"user\"}, {\"type\": \"group\", \"relation\": \"member\"}]"}
];

openfga.v1.ContextualTupleKeys contextual_tuples = 6 [json_name = "contextual_tuples"];
}

message ListUsersFilter {
string type = 1 [
(validate.rules).string = {
pattern: "^[^:#@\\s]{1,254}$",
ignore_empty: false
},
(google.api.field_behavior) = REQUIRED,
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"group\""}
];
string relation = 2 [
(validate.rules).string = {
pattern: "^[^:#@\\s]{1,50}$",
ignore_empty: true
},
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"member\""}
];
}

message User {
oneof user {
Object object = 1;
UsersetUser userset = 2;
Wildcard wildcard = 3;
}
}

message UsersetUser {
string type = 1 [
(validate.rules).string = {
pattern: "^[^:#@\\s]{1,254}$",
ignore_empty: false
},
(google.api.field_behavior) = REQUIRED,
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"group\""}
];
string id = 2 [
(validate.rules).string = {
pattern: "[^#:\\s]+$",
ignore_empty: false
},
(google.api.field_behavior) = REQUIRED
];
string relation = 3 [
(validate.rules).string = {
pattern: "^[^:#@\\s]{1,50}$",
ignore_empty: true
},
(google.api.field_behavior) = REQUIRED,
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"member\""}
];
}

message ListUsersResponse {
repeated User users = 1 [
json_name = "users",
(google.api.field_behavior) = REQUIRED,
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: ""}
];
}

message StreamedListObjectsRequest {
string store_id = 1 [
json_name = "store_id",
Expand Down
Loading
Loading