analyzer

type APIClarityConfig struct {
}

type APIClarityDriftResult struct {
	Events []*models2.APIEvent

	EventProvidedSpecDiffs []*models2.APIEventSpecDiff
}

type Analyzer struct {
	ID          string            `json:"id,omitempty" gorm:"column:id;primaryKey"`
	NameID      string            `json:"name_id" gorm:"column:name_id;unique;index"`
	Title       string            `json:"title" gorm:"column:title"`
	Description string            `json:"description" gorm:"column:description"`
	Status      string            `json:"status" gorm:"column:status;index"`
	Meta        datatypes.JSONMap `json:"meta" gorm:"column:meta"`
	Config      Config            `json:"config" gorm:"column:config"`
	CreatedAt   time.Time         `json:"created_at" gorm:"column:created_at"`
	UpdatedAt   time.Time         `json:"updated_at" gorm:"column:updated_at"`
	Position    int               `json:"position" gorm:"column:position"`

	Rules []*Rule `json:"rules" gorm:"foreignKey:AnalyzerNameID;references:NameID;constraint:OnUpdate:CASCADE,OnDelete:SET NULL;"`
}

type AnalyzersScoreConfigs map[SpecAnalyzer]*ScoreConfig

type Config map[string]interface{}

type Finding struct {
	Type  rule.FindingType      `json:"type"`
	Path  []string              `json:"path"`
	Range *FindingPositionRange `json:"range,omitempty"`
	Diff  *FindingDiff          `json:"diff,omitempty"`
}

type FindingDiff struct {
	Old string `json:"old"`
	New string `json:"new"`
}

type FindingPosition struct {
	Line   int `json:"line"`
	Column int `json:"column"`
}

type FindingPositionRange struct {
	Start *FindingPosition `json:"start"`
	End   *FindingPosition `json:"end"`
}

type Findings struct {
	Message    string     `json:"message"`
	Mitigation string     `json:"mitigation"`
	Data       []*Finding `json:"data"`
}

type Result struct {
	Summary  *ResultSummary       `json:"summary" gorm:"column:summary"`
	Findings SeverityRuleFindings `json:"findings" gorm:"column:findings"`
	// contains filtered or unexported fields
}

type ResultSummary struct {
	Stats *SeverityRuleFindingsStats `json:"stats"`
}

type Resulter interface{ Result() (*Result, error) }

type Rule struct {
	ID             string            `json:"id,omitempty" gorm:"column:id;primaryKey"`
	NameID         string            `json:"name_id" gorm:"column:name_id;unique;index"`
	AnalyzerNameID string            `json:"analyzer_name_id" gorm:"column:analyzer_name_id;index"`
	Title          string            `json:"title" gorm:"column:title"`
	Description    string            `json:"description" gorm:"column:description"`
	Severity       string            `json:"severity" gorm:"column:severity"`
	Mitigation     string            `json:"mitigation" gorm:"column:mitigation"`
	Meta           datatypes.JSONMap `json:"meta" gorm:"column:meta"`
	CreatedAt      time.Time         `json:"created_at" gorm:"column:created_at"`
	UpdatedAt      time.Time         `json:"updated_at" gorm:"column:updated_at"`
}

type RuleFindings struct {
	Rules map[rule.NameID]*Findings `json:"rules"`
}

type RuleFindingsStats struct {
	Count       int                 `json:"count"`
	Occurrences int                 `json:"occurrences"`
	Data        map[rule.NameID]int `json:"rules"`
}

type ScoreConfig struct {
	AnalyzerWeight  *float32                  `json:"analyzer_weight"`
	SeverityWeights map[rule.SeverityName]int `json:"severity_weights"`
}

type SecurityConfig struct {
	Name string // composed sac external api name, e.g. carts.api.apiregistry
}

type SecurityFinding struct {
	Severity           string        `json:"severity"`
	Kind               string        `json:"kind"`
	Type               string        `json:"type"`
	Code               string        `json:"code"`
	Message            string        `json:"message"`
	Location           []interface{} `json:"location"`
	CrRawFindingID     string        `json:"cr_raw_finding_id"`
	CrFindingIndex     int           `json:"cr_finding_index"`
	AffectedEndpoints  []interface{} `json:"affected_endpoints"`
	Source             string        `json:"source"`
	SeverityCategory   string        `json:"severity_category"`
	CrankshaftClassID  string        `json:"crankshaft_class_id"`
	CrankshaftSeverity string        `json:"crankshaft_severity"`
	CrankshaftCategory string        `json:"crankshaft_category"`
	CrankshaftJsonpath string        `json:"crankshaft_jsonpath"`
}

type SeverityRuleFindings map[rule.SeverityName]*RuleFindings

type SeverityRuleFindingsStats struct {
	Count       int                `json:"count"`
	Occurrences int                `json:"occurrences"`
	Hint        *RuleFindingsStats `json:"hint"`
	Info        *RuleFindingsStats `json:"info"`
	Warning     *RuleFindingsStats `json:"warning"`
	Error       *RuleFindingsStats `json:"error"`
}

type SpecAnalyzer string

type SpectralConfig struct {
	Ruleset *string // choose a ruleset [string] [choices: "cisco", "cisco-without-oas", "cx", "cx-without-oas", "cx-dictionary"] [default: "cisco-without-oas"]
}

type SpectralResult []*SpectralResultItem

type SpectralResultItem struct {
	Code     string   `json:"code"`
	Path     []string `json:"path"`
	Message  string   `json:"message"`
	Severity int      `json:"severity"`
	Range    struct {
		Start struct {
			Line      int `json:"line"`
			Character int `json:"character"`
		} `json:"start"`
		End struct {
			Line      int `json:"line"`
			Character int `json:"character"`
		} `json:"end"`
	} `json:"range"`
	Source string `json:"source"`
}

type WokeConfig struct {
	Config              string // Config file (default is .woke.yaml in current directory, or $HOME)
	DisableDefaultRules bool   // Disable the default ruleset
	ExitOneOnFailure    bool   // Exit with exit code 1 on failures
	NoIgnore            bool   // Ignored files in .gitignore, .ignore, .wokeignore, .git/info/exclude, and inline ignores are processed
	OutputName          string // Output type [text,simple,github-actions,json,sonarqube]
}

type WokeResult struct {
	Filename string `json:"Filename"`
	Results  []struct {
		Rule struct {
			Name         string   `json:"Name"`
			Terms        []string `json:"Terms"`
			Alternatives []string `json:"Alternatives"`
			Note         string   `json:"Note"`
			Severity     string   `json:"Severity"`
			Options      struct {
				WordBoundary      bool        `json:"WordBoundary"`
				WordBoundaryStart bool        `json:"WordBoundaryStart"`
				WordBoundaryEnd   bool        `json:"WordBoundaryEnd"`
				IncludeNote       bool        `json:"IncludeNote"`
				Categories        interface{} `json:"Categories"`
			} `json:"Options"`
		} `json:"Rule"`
		Finding       string `json:"Finding"`
		Line          string `json:"Line"`
		StartPosition struct {
			Filename string `json:"Filename"`
			Offset   int    `json:"Offset"`
			Line     int    `json:"Line"`
			Column   int    `json:"Column"`
		} `json:"StartPosition"`
		EndPosition struct {
			Filename string `json:"Filename"`
			Offset   int    `json:"Offset"`
			Line     int    `json:"Line"`
			Column   int    `json:"Column"`
		} `json:"EndPosition"`
		Reason string `json:"Reason"`
	} `json:"Results"`
}