requirementsourceadmission

Documentation

Index

• func AdmitClaimLevel(raw any, context string) (string, error)
• func AdmitInvariantText(raw any, context string) (string, error)
• func AdmitLifecycleState(raw any, context string) (string, error)
• func AdmitRequirementID(raw any, context string) (string, error)
• func Build(raw any) (report.Record, int, error)
• func RequirementValue(requirement Requirement) map[string]any
• func SourceValue(source Source) map[string]any
• type ComparisonField
  • func ComparisonFields(requirement Requirement) []ComparisonField
• type Deferral
• type Lifecycle
• type Requirement
  • func AdmitRequirement(raw any) (Requirement, error)
• type Result
  • func Evaluate(raw any) (Result, error)
• type Source
• type UpdatePolicy

Functions

func AdmitClaimLevel

func AdmitClaimLevel(raw any, context string) (string, error)

func AdmitInvariantText

func AdmitInvariantText(raw any, context string) (string, error)

func AdmitLifecycleState

func AdmitLifecycleState(raw any, context string) (string, error)

func AdmitRequirementID

func AdmitRequirementID(raw any, context string) (string, error)

func Build

func Build(raw any) (report.Record, int, error)

func RequirementValue

func RequirementValue(requirement Requirement) map[string]any

func SourceValue

func SourceValue(source Source) map[string]any

Types

type ComparisonField

type ComparisonField struct {
	Class string
	Name  string
	Value any
}

func ComparisonFields

func ComparisonFields(requirement Requirement) []ComparisonField

ComparisonFields is the requirement owner's exhaustive review projection. Adding a review-significant field requires changing this owner-local list.

type Deferral

type Deferral struct {
	EvidenceRefs    []string
	ExpiryRef       string
	MergePolicy     string
	OwnerID         string
	ReviewCondition string
	RiskAcceptedBy  string
}

type Lifecycle

type Lifecycle struct {
	EvidenceRefs              []string
	ReplacementRequirementIDs []string
	State                     string
}

type Requirement

type Requirement struct {
	ClaimLevel       string
	Deferral         *Deferral
	Invariant        string
	Lifecycle        Lifecycle
	NonClaimRefs     []string
	NonClaims        []string
	OwnerID          string
	ProofBindingRefs []string
	RequirementID    string
	RiskClass        string
	UpdatePolicy     UpdatePolicy
}

func AdmitRequirement

func AdmitRequirement(raw any) (Requirement, error)

AdmitRequirement exposes the requirement owner's canonical leaf admission.

type Result

type Result struct {
	ExitCode int
	Failures []string
	Report   report.Record
	Source   Source
}

func Evaluate

func Evaluate(raw any) (Result, error)

type Source

type Source struct {
	NonClaims        []string
	OverviewPath     string
	Requirements     []Requirement
	RequirementsPath string
	SourceID         string
	SpecPackagePath  string
}

type UpdatePolicy

type UpdatePolicy struct {
	RequiresImpactDeclaration  bool
	RequiresProofBindingReview bool
	ReviewOwnerID              string
}