model

Nov 19, 2024

Changes in this version

+ var AllExceptOAS3_1 = []string

Jul 9, 2024

Changes in this version

+ type IgnoredItems map[string][]string

May 25, 2024

Changes in this version

+ const FunctionCategoryCore

+ const FunctionCategoryCustomJS

+ const FunctionCategoryOWASP

+ const FunctionCategoryOpenAPI

type RuleFunction

+ GetCategory func() string

Feb 8, 2024

Changes in this version

+ const GithubUrl

+ const WebsiteUrl

Jan 5, 2024

Changes in this version

type RuleFunctionContext

+ DrDocument *model.DrDocument

Nov 26, 2023

Changes in this version

type RuleFunctionResult

+ Origin *index.NodeOrigin

Nov 18, 2023

Changes in this version

type Rule

+ Message string

type RuleFunctionContext

+ Logger *slog.Logger

Jul 6, 2023

Changes in this version

+ const CategoryOWASP

May 1, 2023

Changes in this version

type RuleFunctionContext

+ Document libopenapi.Document

type RuleFunctionResult

+ ModelContext any

+ func BuildFunctionResultWithDescription(desc, key, message string, value interface{}) RuleFunctionResult

Dec 16, 2022

Changes in this version

+ func CompileRegex(context RuleFunctionContext, pattern string, results *[]RuleFunctionResult) *regexp.Regexp

Dec 8, 2022

Changes in this version

type RuleFunctionResult

+ Timestamp *time.Time

Oct 21, 2022

Changes in this version

+ const SeverityError

+ const SeverityHint

+ const SeverityInfo

+ const SeverityWarn

Jul 22, 2022

Changes in this version

type RuleResultSet

+ ErrorCount int

+ InfoCount int

+ WarnCount int

Jun 11, 2022

Changes in this version

type Rule

+ PrecompiledPattern *regexp.Regexp

type RuleFunctionResult

+ Range reports.Range

+ RuleId string

+ RuleSeverity string

type RuleResultSet

+ func NewRuleResultSetPointer(results []*RuleFunctionResult) *RuleResultSet

+ func (rr *RuleResultSet) PrepareForSerialization(info *SpecInfo)

type SpecInfo

+ Generated time.Time

Jun 6, 2022

Changes in this version

+ const CategoryAll

type Reference

+ ParentNode *yaml.Node

type RuleCategoryResult

+ Truncated bool

type RuleResultSet

+ func (rr *RuleResultSet) GetHintByRuleCategory(category string) []*RuleFunctionResult

+ func (rr *RuleResultSet) GetResultsForCategoryWithLimit(category string, limit int) *RuleResultsForCategory

type RuleResultsForCategory

+ RuleResults []*RuleCategoryResult

type SpecIndex

+ func (index *SpecIndex) GetLinesWithReferences() map[int]bool

+ func (index *SpecIndex) GetRefsByLine() map[string]map[int]bool

May 13, 2022

Changes in this version

+ const CategoryDescriptions

+ const CategoryExamples

+ const CategoryInfo

+ const CategoryOperations

+ const CategorySchemas

+ const CategorySecurity

+ const CategoryTags

+ const CategoryValidation

+ const OAS2

+ const OAS3

+ const OAS31

+ var AllFormats = []string

+ var OAS2Format = []string

+ var OAS3AllFormat = []string

+ var OAS3Format = []string

+ var OAS3_1Format = []string

+ var OpenAPI2SchemaData string

+ var OpenAPI3SchemaData string

+ var RuleCategories = make(map[string]*RuleCategory)

+ var RuleCategoriesOrdered []*RuleCategory

+ func AreValuesCorrectlyTyped(valType string, values interface{}) map[string]string

+ func CheckEnumForDuplicates(seq []*yaml.Node) []*yaml.Node

+ func ValidateRuleFunctionContextAgainstSchema(ruleFunction RuleFunction, ctx RuleFunctionContext) (bool, []string)

+ type CircularReferenceResult struct

+ Journey []*Reference

+ JourneyString string

+ LoopIndex int

+ LoopPoint *Reference

+ Start *Reference

+ type Context struct

+ Character int

+ Line int

+ type DescriptionReference struct

+ Content string

+ IsSummary bool

+ Node *yaml.Node

+ Path string

+ type EnumReference struct

+ Node *yaml.Node

+ Path string

+ Type *yaml.Node

+ type Example struct

+ Description string

+ ExternalValue string

+ Summary string

+ Value interface{}

+ type ExternalLookupFunction func(id string) (foundNode *yaml.Node, rootNode *yaml.Node, lookupError error)

+ type IndexingError struct

+ Error error

+ Node *yaml.Node

+ Path string

+ type Range struct

+ End Context

+ Start Context

+ type Reference struct

+ Circular bool

+ Definition string

+ Name string

+ Node *yaml.Node

+ Path string

+ Resolved bool

+ Seen bool

+ type ReferenceMapped struct

+ Definition string

+ Reference *Reference

+ type Report struct

+ Code string

+ Message string

+ Path []string

+ Range Range

+ Severity int

+ type Rule struct

+ Description string

+ Formats []string

+ Given interface{}

+ HowToFix string

+ Id string

+ Name string

+ PrecomiledPattern *regexp.Regexp

+ Recommended bool

+ Resolved bool

+ RuleCategory *RuleCategory

+ Severity string

+ Then interface{}

+ Type string

+ func (r *Rule) GetSeverityAsIntValue() int

+ func (r Rule) ToJSON() string

+ type RuleAction struct

+ Field string

+ Function string

+ FunctionOptions interface{}

+ func CastToRuleAction(action interface{}) *RuleAction

+ type RuleCategory struct

+ Description string

+ Id string

+ Name string

+ type RuleCategoryResult struct

+ Errors int

+ Health int

+ Hints int

+ Info int

+ Results []*RuleFunctionResult

+ Rule *Rule

+ Seen int

+ Warnings int

+ type RuleFunction interface

+ GetSchema func() RuleFunctionSchema

+ RunRule func(nodes []*yaml.Node, context RuleFunctionContext) []RuleFunctionResult

+ type RuleFunctionContext struct

+ Given interface{}

+ Index *SpecIndex

+ Options interface{}

+ Rule *Rule

+ RuleAction *RuleAction

+ SpecInfo *SpecInfo

+ type RuleFunctionProperty struct

+ Description string

+ Name string

+ type RuleFunctionResult struct

+ EndNode *yaml.Node

+ Message string

+ Path string

+ Rule *Rule

+ StartNode *yaml.Node

+ func BuildFunctionResult(key, message string, value interface{}) RuleFunctionResult

+ func BuildFunctionResultString(message string) RuleFunctionResult

+ func MapPathAndNodesToResults(path string, startNode, endNode *yaml.Node, results []RuleFunctionResult) []RuleFunctionResult

+ type RuleFunctionSchema struct

+ ErrorMessage string

+ MaxProperties int

+ MinProperties int

+ Name string

+ Properties []RuleFunctionProperty

+ Required []string

+ RequiresField bool

+ func (rfs RuleFunctionSchema) GetPropertyDescription(name string) string

+ type RuleResultSet struct

+ Results []*RuleFunctionResult

+ func NewRuleResultSet(results []RuleFunctionResult) *RuleResultSet

+ func (rr *RuleResultSet) CalculateCategoryHealth(category string) int

+ func (rr *RuleResultSet) GenerateSpectralReport(source string) []SpectralReport

+ func (rr *RuleResultSet) GetErrorCount() int

+ func (rr *RuleResultSet) GetErrorsByRuleCategory(category string) []*RuleFunctionResult

+ func (rr *RuleResultSet) GetInfoByRuleCategory(category string) []*RuleFunctionResult

+ func (rr *RuleResultSet) GetInfoCount() int

+ func (rr *RuleResultSet) GetResultsByRuleCategory(category string) []*RuleFunctionResult

+ func (rr *RuleResultSet) GetRuleResultsForCategory(category string) *RuleResultsForCategory

+ func (rr *RuleResultSet) GetWarnCount() int

+ func (rr *RuleResultSet) GetWarningsByRuleCategory(category string) []*RuleFunctionResult

+ func (rr *RuleResultSet) Len() int

+ func (rr *RuleResultSet) Less(i, j int) bool

+ func (rr *RuleResultSet) SortResultsByLineNumber() []*RuleFunctionResult

+ func (rr *RuleResultSet) Swap(i, j int)

+ type RuleResultsForCategory struct

+ Category *RuleCategory

+ Rules []*RuleCategoryResult

+ func (rr *RuleResultsForCategory) Len() int

+ func (rr *RuleResultsForCategory) Less(i, j int) bool

+ func (rr *RuleResultsForCategory) Swap(i, j int)

+ type SearchResult struct

+ Col int

+ Key string

+ Line int

+ type SpecIndex struct

+ func NewSpecIndex(rootNode *yaml.Node) *SpecIndex

+ func (index *SpecIndex) ExtractComponentsFromRefs(refs []*Reference) []*Reference

+ func (index *SpecIndex) ExtractExternalDocuments(node *yaml.Node) []*Reference

+ func (index *SpecIndex) ExtractRefs(node *yaml.Node, seenPath []string, level int, poly bool, pName string) []*Reference

+ func (index *SpecIndex) FindComponent(componentId string, parent *yaml.Node) *Reference

+ func (index *SpecIndex) GetAllCallbacks() map[string]*Reference

+ func (index *SpecIndex) GetAllCombinedReferences() map[string]*Reference

+ func (index *SpecIndex) GetAllDescriptions() []*DescriptionReference

+ func (index *SpecIndex) GetAllDescriptionsCount() int

+ func (index *SpecIndex) GetAllEnums() []*EnumReference

+ func (index *SpecIndex) GetAllExamples() map[string]*Reference

+ func (index *SpecIndex) GetAllExternalDocuments() map[string]*Reference

+ func (index *SpecIndex) GetAllHeaders() map[string]*Reference

+ func (index *SpecIndex) GetAllLinks() map[string]*Reference

+ func (index *SpecIndex) GetAllOperationsServers() map[string]map[string][]*Reference

+ func (index *SpecIndex) GetAllParameters() map[string]*Reference

+ func (index *SpecIndex) GetAllParametersFromOperations() map[string]map[string]map[string]*Reference

+ func (index *SpecIndex) GetAllPaths() map[string]map[string]*Reference

+ func (index *SpecIndex) GetAllReferences() map[string]*Reference

+ func (index *SpecIndex) GetAllRequestBodies() map[string]*Reference

+ func (index *SpecIndex) GetAllResponses() map[string]*Reference

+ func (index *SpecIndex) GetAllRootServers() []*Reference

+ func (index *SpecIndex) GetAllSchemas() map[string]*Reference

+ func (index *SpecIndex) GetAllSecuritySchemes() map[string]*Reference

+ func (index *SpecIndex) GetAllSequencedReferences() []*Reference

+ func (index *SpecIndex) GetAllSummaries() []*DescriptionReference

+ func (index *SpecIndex) GetAllSummariesCount() int

+ func (index *SpecIndex) GetComponentParameterCount() int

+ func (index *SpecIndex) GetComponentSchemaCount() int

+ func (index *SpecIndex) GetDiscoveredReferences() map[string]*Reference

+ func (index *SpecIndex) GetGlobalLinksCount() int

+ func (index *SpecIndex) GetGlobalTagsCount() int

+ func (index *SpecIndex) GetGlobalTagsNode() *yaml.Node

+ func (index *SpecIndex) GetInlineDuplicateParamCount() int

+ func (index *SpecIndex) GetInlineOperationDuplicateParameters() map[string][]*Reference

+ func (index *SpecIndex) GetInlineUniqueParamCount() int

+ func (index *SpecIndex) GetMappedReferences() map[string]*Reference

+ func (index *SpecIndex) GetMappedReferencesSequenced() []*ReferenceMapped

+ func (index *SpecIndex) GetOperationCount() int

+ func (index *SpecIndex) GetOperationParameterReferences() map[string]map[string]map[string]*Reference

+ func (index *SpecIndex) GetOperationParametersIndexErrors() []*IndexingError

+ func (index *SpecIndex) GetOperationTags() map[string]map[string][]*Reference

+ func (index *SpecIndex) GetOperationTagsCount() int

+ func (index *SpecIndex) GetOperationsParameterCount() int

+ func (index *SpecIndex) GetParametersNode() *yaml.Node

+ func (index *SpecIndex) GetPathCount() int

+ func (index *SpecIndex) GetPathsNode() *yaml.Node

+ func (index *SpecIndex) GetPolyAllOfReferences() []*Reference

+ func (index *SpecIndex) GetPolyAnyOfReferences() []*Reference

+ func (index *SpecIndex) GetPolyOneOfReferences() []*Reference

+ func (index *SpecIndex) GetPolyReferences() map[string]*Reference

+ func (index *SpecIndex) GetRawReferenceCount() int

+ func (index *SpecIndex) GetReferencesWithSiblings() map[string]*Reference

+ func (index *SpecIndex) GetRootNode() *yaml.Node

+ func (index *SpecIndex) GetRootSecurityNode() *yaml.Node

+ func (index *SpecIndex) GetRootSecurityReferences() []*Reference

+ func (index *SpecIndex) GetRootServersNode() *yaml.Node

+ func (index *SpecIndex) GetSchemasNode() *yaml.Node

+ func (index *SpecIndex) GetTotalTagsCount() int

+ type SpecInfo struct

+ APISchema gojsonschema.JSONLoader

+ Error error

+ RootNode *yaml.Node

+ SpecBytes *[]byte

+ SpecFileType string

+ SpecFormat string

+ SpecJSON *map[string]interface{}

+ SpecJSONBytes *[]byte

+ SpecType string

+ Version string

+ func ExtractSpecInfo(spec []byte) (*SpecInfo, error)

+ func (si SpecInfo) GetJSONParsingChannel() chan bool

+ type SpectralRange struct

+ End SpectralRangeItem

+ Start SpectralRangeItem

+ type SpectralRangeItem struct

+ Char int

+ Line int

+ type SpectralReport struct

+ Code string

+ Message string

+ Path []string

+ Range SpectralRange

+ Severity int

+ Source string