Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CoveredBy ¶
type CoveredBy struct {
ComponentKey string `yaml:"component_key" json:"component_key"`
VerificationKey string `yaml:"verification_key" json:"verification_key"`
}
CoveredBy struct is the pointing mechanism for for referring to VerificationReferences in the documentation. This struct is a one-to-one mapping of `covered_by` in the component.yaml schema https://github.com/opencontrol/schemas#component-yaml
type GeneralReference ¶
type GeneralReference struct {
Name string `yaml:"name" json:"name"`
Path string `yaml:"path" json:"path"`
Type string `yaml:"type" json:"type"`
}
GeneralReference struct contains data for the name and path of a compliance reference. This struct is a one-to-one mapping of `references` in the component.yaml schema https://github.com/opencontrol/schemas#component-yaml
type GeneralReferences ¶
type GeneralReferences []GeneralReference
GeneralReferences a slice of type GeneralReference
func (GeneralReferences) Len ¶
func (slice GeneralReferences) Len() int
Len returns the length of the GeneralReferences slice
func (GeneralReferences) Less ¶
func (slice GeneralReferences) Less(i, j int) bool
Less returns true if a GeneralReference is less than another reference
func (GeneralReferences) Swap ¶
func (slice GeneralReferences) Swap(i, j int)
Swap swaps the two GeneralReferences
type VerificationReference ¶
type VerificationReference struct {
GeneralReference `yaml:",inline"`
Key string `yaml:"key" json:"key"`
}
VerificationReference struct is a general reference that verifies a specific control, it can be pointed to in the control documentation. This struct is a one-to-one mapping of `verifications` in the component.yaml schema https://github.com/opencontrol/schemas#component-yaml
type VerificationReferences ¶
type VerificationReferences []VerificationReference
VerificationReferences a slice of type VerificationReference
func (VerificationReferences) Get ¶
func (slice VerificationReferences) Get(key string) VerificationReference
Get returns a VerificationReference of the given key
func (VerificationReferences) Len ¶
func (slice VerificationReferences) Len() int
Len returns the length of the VerificationReference slice
func (VerificationReferences) Less ¶
func (slice VerificationReferences) Less(i, j int) bool
Less returns true if a VerificationReference is less than another reference
func (VerificationReferences) Swap ¶
func (slice VerificationReferences) Swap(i, j int)
Swap swaps the two VerificationReferences
Source Files