api

Documentation

Index

• type Analyze
• type Doc
  • func DeserializeDoc(b []byte) (doc Doc, err error)
• type Result

Types

type Analyze

type Analyze struct {
	V1 []v1.AnalyzerSpec `json:"v1,omitempty" yaml:"v1,omitempty" hcl:"v1,omitempty"`
}

Analyze is the top level analyze object

type Doc

type Doc struct {
	Analyze Analyze `json:"analyze" yaml:"analyze" hcl:"analyze"`
}

Doc is the top level Analyze document that defines an set of collectors and analysis

func DeserializeDoc

func DeserializeDoc(b []byte) (doc Doc, err error)

DeserializeDoc will deserialize a analyze spec. Possibly support more formats?

type Result

type Result struct {
	Message      string                   `json:"message" yaml:"message" hcl:"message"`
	Requirement  string                   `json:"requirement,omitempty" yaml:"requirement,omitempty" hcl:"requirement,omitempty"`
	Severity     common.Severity          `json:"severity" yaml:"severity" hcl:"severity"`
	AnalyzerSpec Analyze                  `json:"analyzer_spec" yaml:"analyzer_spec" hcl:"analyzer_spec"`
	Vars         []map[string]interface{} `json:"variables,omitempty" yaml:"variables,omitempty" hcl:"variables,omitempty"`
	Error        string                   `json:"error,omitempty" yaml:"error,omitempty" hcl:"error,omitempty"`
}