rules

type Expectation string

type File struct {
	// Version is the document format version. Only 1 exists.
	Version int `yaml:"version"`
	// Rules are the expectations to enforce.
	Rules []Rule `yaml:"rules"`
}

type Proposal struct {
	// Rule is the expectation, resolved: the profile's own table and column
	// names, and any values already materialized from the data.
	Rule Rule `json:"rule"`
	// Rationale is the argument for it, for the person deciding whether to
	// accept. It is prose from whoever proposed the rule and carries no
	// authority of its own.
	Rationale string `json:"rationale,omitempty"`
	// ViolationsNow is what the rule measured against the data in front of it
	// when it was proposed.
	ViolationsNow int64 `json:"violations_now"`
	// Display is the source a person recognizes — "sales.xlsx#Q1" — since
	// Rule.Table carries the SQL name the rule has to be written against.
	Display string `json:"display,omitempty"`
}

type Rule struct {
	// ID names the rule in reports. Required and unique within a file.
	ID string `yaml:"id"`
	// Description explains what the rule is for, in the report.
	Description string `yaml:"description,omitempty"`
	// Severity defaults to error when omitted: a rule the customer wrote
	// states an expectation they hold, not a suggestion. It is a pointer so
	// that an omitted severity is distinguishable from an explicit "info".
	Severity *finding.Severity `yaml:"severity,omitempty"`

	// Table selects tables by name or display path. A "*" matches any run of
	// characters, so "*.csv" applies a rule to every CSV in the dataset.
	Table string `yaml:"table"`
	// Column selects a column, with the same globbing.
	Column string `yaml:"column,omitempty"`

	// Expect is the assertion.
	Expect Expectation `yaml:"expect"`

	// Values enumerates the permitted values for one_of.
	Values []string `yaml:"values,omitempty"`
	// ValuesFrom asks Veritix to fill Values in from the data instead of
	// listing them, which is how a rule proposed by a model gets a value
	// list: the model is never shown a cell value, so it can propose the
	// shape of the expectation but not its contents. Materialize resolves
	// it; an accepted rule carries the concrete list.
	ValuesFrom ValuesSource `yaml:"values_from,omitempty"`
	// Pattern is the regular expression for matches.
	Pattern string `yaml:"pattern,omitempty"`
	// Min and Max bound a range. Either may be omitted.
	Min *float64 `yaml:"min,omitempty"`
	Max *float64 `yaml:"max,omitempty"`
	// References names the table and column that must contain every value,
	// written as "table.column".
	References string `yaml:"references,omitempty"`
	// Where is the violation predicate for expect: sql.
	Where string `yaml:"where,omitempty"`

	// IgnoreCase compares text without regard to case or surrounding spaces.
	// Usually what a human means, and rarely what SQL does by default.
	IgnoreCase bool `yaml:"ignore_case,omitempty"`
	// AllowMissing exempts null and blank values from the rule, so that
	// "must be one of these four values" does not also mean "and must be
	// present". Completeness is a separate expectation.
	AllowMissing bool `yaml:"allow_missing,omitempty"`

	// Message overrides the generated finding title.
	Message string `yaml:"message,omitempty"`
	// Remedy overrides the generated advice.
	Remedy string `yaml:"remedy,omitempty"`
}

type ValuesSource string