Skip to content

Document that lookup APIs do not guarantee unique results #171

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
+11 −0
Open

Document that lookup APIs do not guarantee unique results #171

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
9 changes: 9 additions & 0 deletions authzed/api/v1/permission_service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
syntax = "proto3";
package authzed.api.v1;

Expand Down Expand Up @@ -96,6 +96,11 @@

// LookupResources returns all the resources of a given type that a subject
// can access whether via a computed permission or relation membership.
//
// Results are streamed and **not guaranteed to be unique**: the same resource
// may be returned more than once (for example via caveated/conditional
// results, or when a limit is set), possibly with differing permissionship.
// Callers that require uniqueness should deduplicate results.
rpc LookupResources(LookupResourcesRequest) returns (stream LookupResourcesResponse) {
option (google.api.http) = {
post: "/v1/permissions/resources"
Expand All @@ -108,6 +113,10 @@

// LookupSubjects returns all the subjects of a given type that
// have access whether via a computed permission or relation membership.
//
// Results are streamed and **not guaranteed to be unique**: the same subject
// may be returned more than once, possibly with differing permissionship.
// Callers that require uniqueness should deduplicate results.
rpc LookupSubjects(LookupSubjectsRequest) returns (stream LookupSubjectsResponse) {
option (google.api.http) = {
post: "/v1/permissions/subjects"
Expand Down
2 changes: 2 additions & 0 deletions docs/apidocs.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,6 +472,7 @@
"/v1/permissions/resources": {
"post": {
"summary": "LookupResources returns all the resources of a given type that a subject\ncan access whether via a computed permission or relation membership.",
"description": "Results are streamed and **not guaranteed to be unique**: the same resource\nmay be returned more than once (for example via caveated/conditional\nresults, or when a limit is set), possibly with differing permissionship.\nCallers that require uniqueness should deduplicate results.",
"operationId": "PermissionsService_LookupResources",
"responses": {
"200": {
Expand Down Expand Up @@ -515,6 +516,7 @@
"/v1/permissions/subjects": {
"post": {
"summary": "LookupSubjects returns all the subjects of a given type that\nhave access whether via a computed permission or relation membership.",
"description": "Results are streamed and **not guaranteed to be unique**: the same subject\nmay be returned more than once, possibly with differing permissionship.\nCallers that require uniqueness should deduplicate results.",
"operationId": "PermissionsService_LookupSubjects",
"responses": {
"200": {
Expand Down
Loading