Skip to content

Commit 22a0aac

Browse files
committed
litrpc: update MacaroonPermissions comments
The proto comments are updated to reflect the special case behaviour of the entity-action pairs.
1 parent beb2546 commit 22a0aac

File tree

2 files changed

+20
-4
lines changed

2 files changed

+20
-4
lines changed

litrpc/lit-sessions.pb.go

Lines changed: 10 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

litrpc/lit-sessions.proto

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,18 @@ message AddSessionRequest {
3636
}
3737

3838
message MacaroonPermission {
39-
// The entity a permission grants access to.
39+
// The entity a permission grants access to. If a entity is set to the
40+
// "uri" keyword then the action entry should be one of the special cases
41+
// described in the comment for action.
4042
string entity = 1;
4143

42-
// The action that is granted.
44+
// The action that is granted. If entity is set to "uri", then action must
45+
// be set to either:
46+
// - a particular URI to which access should be granted.
47+
// - a URI regex, in which case access will be granted to each URI that
48+
// matches the regex.
49+
// - the "***readonly***" keyword. This will result in the access being
50+
// granted to all read-only endpoints.
4351
string action = 2;
4452
}
4553

0 commit comments

Comments
 (0)