policy

type FSPackage struct {
	// contains filtered or unexported fields
}

type Package interface {
	// Spec returns the package spec.
	Spec() PackageSpec

	// Rules lists all the rules in the package.
	// NOTE: <Kind> + <Name> is the primary key to a rule query. Therefore, a rule (by name)
	//       can be returned more than once.
	Rules() []Rule

	// ParsedModules returns the parsed rego modules.
	ParsedModules() map[string]*ast.Module
}

type PackageSpec struct {
	// Rule specifies the policy rule settings.
	Rule *RuleSpec `json:"rule,omitempty" yaml:"rule,omitempty"`
}

type QueryKind string

type RegoCompilerOptions struct{}

type Rule struct {
	// Kind specifies the kind of the query.
	Kind QueryKind
	// Name provides the name of the rule.
	Name string
	// Namespace specifies the namespace of the rule.
	Namespace string
	// SourceLocation is the source definition of the rule.
	SourceLocation *ast.Location
}

type RuleSpec struct {
	// DocLink specifies the policy rule document link format.
	//
	// The value will be formatted using text.Template. Following variables are available:
	//
	// - {{.Name}}: the name of the rule.
	// - {{.Kind}}: the kind of the rule. See `QueryKind` for available options.
	// - {{.SourceFileName}}: the source file name (without the .rego extension) of the rule.
	//                        If the rule is not defined in a source file, this will be empty.
	DocLink string `json:"doc_link,omitempty" yaml:"doc_link,omitempty"`
}