Skip to content

Commit

Permalink
x/exp/batch: add docs to batch
Browse files Browse the repository at this point in the history
Signed-off-by: Patrick Jakubowski <[email protected]>
  • Loading branch information
patjakdev committed Nov 13, 2024
1 parent dc5fc31 commit 0f7a25c
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions x/exp/batch/batch.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
// Package batch allows for performant batch evaluations of Cedar policy given a set of principals, actions, resources,
// and/or context as variables. The batch evaluation takes advantage of a form of [partial evaluation] to whittle the
// policy set down to just those policies which refer to the set of unknown variables. This allows for queries over a
// policy set, such as "to which resources can user A connect when the request comes from outside the United States?"
// which can run much faster than a brute force trawl through every possible authorization request.
//
// [partial evaluation]: https://en.wikipedia.org/wiki/Partial_evaluation
package batch

import (
Expand Down

0 comments on commit 0f7a25c

Please sign in to comment.