You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The policy reference contains a list of all the built-in functions; and examples for very few. It would be helpful for getting off the ground if some basic examples showed to to use a built-in.
This issue is broad and not meant to be fixed in a single sweep. Any added examples will be valuable.
The text was updated successfully, but these errors were encountered:
I've got ideas about how to deal with this, centered around well-annotated example rego files.
So if you'd like to pick a builtin to document, please create a rego file like docs/examples/io.jwt.decode_verify.rego,
package examples.builtins.io.jwt.decode_verify
# METADATA# description: |# When used in a simple case, io.jwt.decode_verify does this and that.
test_simple {
jwt :="..."
criteria := { }
io.jwt.decode_verify(jwt, criteria) == { ... }
}
# METADATA# description: To check issuer, the `iss` criterium needs to be provided
test_issuer {
# ...
}
with a few of these in place, we can then worry about hooking them into the website docs automatically, which is a bit of a different story.
The policy reference contains a list of all the built-in functions; and examples for very few. It would be helpful for getting off the ground if some basic examples showed to to use a built-in.
This issue is broad and not meant to be fixed in a single sweep. Any added examples will be valuable.
The text was updated successfully, but these errors were encountered: