baseline

Documentation

Index

• Constants
• func Apply(document Document, diagnostics []policy.Diagnostic) ([]policy.Diagnostic, int)
• func Fingerprint(ruleID string, evidence policy.Evidence) string
• func Write(path string, document Document) error
• type Document
  • func Build(diagnostics []policy.Diagnostic) Document
  • func Load(path string) (Document, error)
  • func (document Document) Validate() error
• type Entry

Constants

const Version = 1

Functions

func Apply

func Apply(document Document, diagnostics []policy.Diagnostic) ([]policy.Diagnostic, int)

func Fingerprint

func Fingerprint(ruleID string, evidence policy.Evidence) string

func Write

func Write(path string, document Document) error

Types

type Document

type Document struct {
	Version int     `json:"version"`
	Entries []Entry `json:"entries"`
}

func Build

func Build(diagnostics []policy.Diagnostic) Document

func Load

func Load(path string) (Document, error)

func (Document) Validate

func (document Document) Validate() error

type Entry

type Entry struct {
	Fingerprint string   `json:"fingerprint"`
	RuleID      string   `json:"rule_id"`
	Issue       string   `json:"issue"`
	Source      string   `json:"source"`
	Relation    string   `json:"relation,omitempty"`
	Target      string   `json:"target,omitempty"`
	Areas       []string `json:"areas,omitempty"`
	SourceArea  string   `json:"source_area,omitempty"`
	TargetArea  string   `json:"target_area,omitempty"`
}