% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/policy.R
\name{list_rules}
\alias{list_rules}
\title{List policy rules}
\usage{
list_rules(policy)
}
\arguments{
\item{policy}{A \code{shieldr_policy} or built-in policy name such as \code{"comprehensive"}.}
}
\value{
A data frame with columns \code{id}, \code{owasp}, \code{severity}, \code{action},
\code{has_pattern}, and \code{has_fn}.
}
\description{
\code{list_rules()} returns a compact inventory of a policy's rule set. It is
intended for audits, examples, tests, and pre-deployment reviews.
}
\details{
The \code{has_pattern} and \code{has_fn} columns identify whether each rule is regex
based or function based. Regex rules can produce redaction spans directly.
Function rules may produce findings without spans unless the function
returns span metadata.
}
\examples{
list_rules(policy("custom"))
}
