Skip to content

Commit 50996d8

Browse files
committed
Change documentation of lookupsubjects cursors
1 parent 7144bbf commit 50996d8

File tree

1 file changed

+7
-24
lines changed

1 file changed

+7
-24
lines changed

authzed/api/v1/permission_service.proto

Lines changed: 7 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -600,32 +600,15 @@ message LookupSubjectsRequest {
600600
// context consists of named values that are injected into the caveat evaluation context
601601
google.protobuf.Struct context = 6 [ (validate.rules).message.required = false ];
602602

603-
// optional_concrete_limit, if non-zero, specifies the limit on the number of
604-
// *concrete* (non-wildcard) subjects to return before the stream is closed on the
605-
// server side. With the default value of zero, the stream will continue resolving
606-
// concrete subjects until exhausted or the stream is closed due to the client or
607-
// a network issue.
608-
//
609-
// NOTE: Wildcard subjects ("*") have special treatment when cursors and limits are used. Because
610-
// wildcards can apply to *any* concrete subjects, if a wildcard subject is found within the dataset,
611-
// a wildcard subject can be returned for *all* LookupSubjects calls, regardless of the cursor or
612-
// limit.
613-
//
614-
// For example, if wildcards are requested, a wildcard subject exists, there is a specified limit
615-
// of 10 concrete subjects, and at least 10 concrete subjects exist, the API will return 11 subjects
616-
// in total: the 10 concrete + the wildcard
617-
//
618-
// Furthermore, if a wildcard has a set of exclusions generated by the dataset,
619-
// the exclusions *will respect the cursor* and only a *partial* set of exclusions will be returned
620-
// for each invocation of the API.
621-
//
622-
// ***IT IS UP TO THE CALLER IN THIS CASE TO COMBINE THE EXCLUSIONS IF DESIRED***
603+
// optional_concrete_limit is currently unimplemented for LookupSubjects
604+
// and will return an error as of SpiceDB version 1.40.1. This will
605+
// be implemented in a future version of SpiceDB.
623606
uint32 optional_concrete_limit = 7 [(validate.rules).uint32 = {gte:0}];
624607

625-
// optional_cursor, if specified, indicates the cursor after which results should resume being returned.
626-
// The cursor can be found on the LookupSubjectsResponse object.
627-
//
628-
// NOTE: See above for notes about how cursors interact with wildcard subjects.
608+
609+
// optional_cursor is currently unimplemented for LookupSubjects
610+
// and will be ignored as of SpiceDB version 1.40.1. This will
611+
// be implemented in a future version of SpiceDB.
629612
Cursor optional_cursor = 8;
630613

631614
// wildcard_option specifies whether wildcards should be returned by LookupSubjects.

0 commit comments

Comments
 (0)