Versions in this module Expand all Collapse all v0 v0.2.0 Jun 7, 2026 Changes in this version + type FileLintReport struct + File string + type MultiLintReport struct + FileReports []FileLintReport + Metadata *ReportMetadata + Status Status + Summary *ViolationSummary + func NewMultiLintReport() *MultiLintReport + func (r *MultiLintReport) AddFileReport(file string, report *LintReport) + func (r *MultiLintReport) FailedFileCount() int + func (r *MultiLintReport) FileCount() int + func (r *MultiLintReport) HasBlockingViolations() bool v0.1.0 Jun 7, 2026 Changes in this version + const ReportStatusFail + const ReportStatusPass + func DefaultConformanceLevels() map[string]ConformanceLevel + type APIStyleSpec struct + Categories []Category + ConformanceLevels map[string]ConformanceLevel + Description string + Exceptions []Exception + Extends []string + Lexicon *Lexicon + Metadata *SpecMetadata + Name string + Overrides map[string]RuleOverride + Rules []Rule + Schema string + Version string + type CasingRules struct + Headers string + Parameters string + Paths string + Properties string + type Category struct + Description string + ID string + Order int + Title string + type ConformanceLevel struct + Description string + Extends string + MaxErrors int + MaxWarnings int + RequiredCategories []string + RequiredRules []string + type Enforcement struct + CustomFunction string + Function string + Given *GivenPaths + Options *EnforcementOptions + Pattern string + Then *SpectralThen + Type EnforcementType + type EnforcementOptions struct + Match string + Max *int + Min *int + NotMatch string + Schema string + Separator string + Type string + Values []string + type EnforcementType string + const EnforcementCustom + const EnforcementNone + const EnforcementRegex + const EnforcementSpectral + type Examples struct + Bad []string + Good []string + type Exception struct + AppliesTo *ExceptionScope + ApprovedBy string + ApprovedOn *time.Time + ExpiresOn *time.Time + ID string + Reason string + RuleID string + Ticket string + func (e *Exception) IsExpired() bool + func (e *Exception) Matches(ruleID, api, path, operation string) bool + type ExceptionScope struct + API string + Operation string + Path string + Paths []string + type ForbiddenTerm struct + Reason string + ReplaceWith string + Term string + type GivenPaths struct + Paths []string + func NewGivenPath(path string) *GivenPaths + func NewGivenPaths(paths ...string) *GivenPaths + type JudgeCriteria struct + Category string + Prompt string + RequiresContext bool + Weight float64 + type Lexicon struct + Aliases map[string]string + Approved []string + CasingRules *CasingRules + Forbidden []ForbiddenTerm + type LintReport struct + ConformanceLevel string + IgnoredViolations []Violation + Metadata *ReportMetadata + Status ReportStatus + Summary *ViolationSummary + Violations []Violation + func NewLintReport() *LintReport + func (r *LintReport) AddViolation(v Violation) + func (r *LintReport) HasBlockingViolations() bool + type Reference struct + Title string + URL string + type ReportMetadata struct + Duration time.Duration + DurationMS int64 + Profile string + ProfileVersion string + RulesEvaluated int + SpecFile string + SpecVersion string + Timestamp time.Time + ToolVersion string + type ReportStatus = Status + type Rule struct + Category string + Enforcement *Enforcement + Examples *Examples + ID string + Judge *JudgeCriteria + Rationale string + Recommended bool + References []Reference + Scope Scope + Severity Severity + Tags []string + Title string + type RuleOverride struct + Disabled bool + Rationale string + Severity *Severity + type Scope string + const ScopeGlobal + const ScopeInfo + const ScopeOperation + const ScopeParameter + const ScopePath + const ScopeResponse + const ScopeSchema + const ScopeSecurity + func (s Scope) String() string + type Severity string + const SeverityError + const SeverityHint + const SeverityInfo + const SeverityWarn + func (s Severity) IsBlocking() bool + func (s Severity) String() string + func (s Severity) Weight() int + type SpecMetadata struct + Author string + Contact string + LastUpdated string + License string + Repository string + URL string + Website string + type SpectralThen struct + Field string + Function string + FunctionOptions map[string]string + type Status string + const StatusFail + const StatusPass + type Violation struct + Category string + Column int + EndColumn int + EndLine int + Line int + Message string + Path string + RuleID string + RuleTitle string + Severity Severity + Suggestion string + type ViolationSummary struct + Errors int + Hints int + Infos int + Total int + Warnings int
Go to main page