Skip to content

Commit 3d5d725

Browse files
committed
cedar-go: add documentation for batch and Go version requirements
Signed-off-by: Patrick Jakubowski <patrick.jakubowski@strongdm.com>
1 parent b9847c9 commit 3d5d725

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,13 +139,18 @@ If you're looking to integrate Cedar into a production system, please be sure th
139139
- `x/exp` - code in this directory is not subject to the semantic versioning constraints of the rest of the module and breaking changes may be made at any time.
140140
- Variadics may be added to functions that do not have them to expand the arguments of a function or method.
141141
- Concrete types may be replaced with compatible interfaces to expand the variety of arguments a function or method can take.
142+
- Backwards compatibility is maintained for all Go minor versions released within 6 months of a release of cedar-go.
142143

143144
## Change log
144145

145146
### New features in 1.2.0
146147
- Support for the .isEmpty() operator.
147-
- A new top-level Authorize() function, which allows authorization against a generic policy iterator instead of requiring a PolicySet. Like the EntityGetter interface does for entities, using a generic iterator enables policy to be retrieved from external sources or for policy to be selected dynamically by the iterator implementation without having to clone an entire PolicySet. Requires Go 1.23.
148-
- First class Iterator support for EntityUIDSet, Record, Set, and PolicySet container types. Requires Go 1.23.
148+
- A new top-level Authorize() function, which allows authorization against a generic policy iterator ([AuthorizationPolicySet](authorize.go)) instead of requiring a PolicySet. Like the EntityGetter interface does for entities, using a generic iterator enables policy to be retrieved from external sources or for policy to be selected dynamically by the iterator implementation without having to clone an entire PolicySet.
149+
- batch.Authorize() likewise now also accepts an `AuthorizationPolicySet`.
150+
- First class iterator support for EntityUIDSet, Record, Set, and PolicySet container types.
151+
152+
### Upgrading from 1.1.x to 1.2.0
153+
- cedar-go now requires Go 1.23
149154

150155
### New features in 1.1.0
151156
- Support for entity tags via the .getTag() and .hasTag() operators.

0 commit comments

Comments
 (0)