framework

Documentation

Index

• type Control
• type Framework
  • func Load(idOrFile string) (*Framework, error)
  • func LoadFile(path string) (*Framework, error)
• type Info
  • func List() ([]Info, error)

Types

type Control

type Control struct {
	ID                  string    `yaml:"id" json:"id"`
	Title               string    `yaml:"title" json:"title"`
	RequiredRecordTypes []string  `yaml:"required_record_types,omitempty" json:"required_record_types,omitempty"`
	MinimumFrequency    string    `yaml:"minimum_frequency,omitempty" json:"minimum_frequency,omitempty"`
	RequiredFields      []string  `yaml:"required_fields,omitempty" json:"required_fields,omitempty"`
	Children            []Control `yaml:"children,omitempty" json:"children,omitempty"`
}

type Framework

type Framework struct {
	Framework struct {
		ID      string `yaml:"id" json:"id"`
		Version string `yaml:"version" json:"version"`
		Title   string `yaml:"title" json:"title"`
	} `yaml:"framework" json:"framework"`
	Controls []Control `yaml:"controls" json:"controls"`
}

func Load

func Load(idOrFile string) (*Framework, error)

func LoadFile

func LoadFile(path string) (*Framework, error)

type Info

type Info struct {
	ID           string `json:"id"`
	Version      string `json:"version"`
	Title        string `json:"title"`
	ControlCount int    `json:"control_count"`
	File         string `json:"file"`
}

func List

func List() ([]Info, error)