docs/projects/regal/rules/style/detached-metadata.md
Summary: Detached metadata annotation
Category: Style
Avoid
package authz
# METADATA
# description: allow any requests by admin users
allow if {
"admin" in input.user.roles
}
Prefer
package authz
# METADATA
# description: allow any requests by admin users
allow if {
"admin" in input.user.roles
}
Metadata annotations should be placed directly above the package, rule or function they are annotating. While OPA accepts any number of newlines between an annotation and the package/rule it applies to, this makes it difficult to connect the two when reading the policy. Always optimize for readability!
This linter rule provides the following configuration options:
rules:
style:
detached-metadata:
# one of "error", "warning", "ignore"
level: error