rulesets

Jan 19, 2024

Changes in this version

+ const OasSchemaCheck

+ func GetSchemaTypeCheckRule() *model.Rule

Jan 5, 2024

Changes in this version

+ const Oas3ExampleExternalCheck

+ const Oas3ExampleMissingCheck

+ func GetOAS3ExamplesExternalCheck() *model.Rule

+ func GetOAS3ExamplesMissingRule() *model.Rule

type RuleSet

+ func GenerateOWASPOpenAPIRuleSet() *RuleSet

Dec 13, 2023

Changes in this version

+ func CheckForLocalExtends(extends map[string]string) bool

+ func CheckForRemoteExtends(extends map[string]string) bool

+ func SniffOutAllExternalRules(ctx context.Context, rsm *ruleSetsModel, location string, visited []string, ...)

type RuleSet

+ func DownloadRemoteRuleSet(_ context.Context, location string) (*RuleSet, error)

+ func LoadLocalRuleSet(_ context.Context, location string) (*RuleSet, error)

Nov 18, 2023

Changes in this version

type RuleSets

+ func BuildDefaultRuleSetsWithLogger(logger *slog.Logger) RuleSets

Jul 6, 2023

Changes in this version

+ const OwaspArrayLimit

+ const OwaspAuthInsecureSchemes

+ const OwaspConstrainedAdditionalProperties

+ const OwaspDefineErrorResponses401

+ const OwaspDefineErrorResponses429

+ const OwaspDefineErrorResponses500

+ const OwaspDefineErrorValidation

+ const OwaspIntegerFormat

+ const OwaspIntegerLimit

+ const OwaspIntegerLimitLegacy

+ const OwaspJWTBestPractices

+ const OwaspNoAPIKeysInURL

+ const OwaspNoAdditionalProperties

+ const OwaspNoCredentialsInURL

+ const OwaspNoHttpBasic

+ const OwaspNoNumericIDs

+ const OwaspProtectionGlobalSafe

+ const OwaspProtectionGlobalUnsafe

+ const OwaspProtectionGlobalUnsafeStrict

+ const OwaspRateLimit

+ const OwaspRateLimitRetryAfter

+ const OwaspSecurityHostsHttpsOAS2

+ const OwaspSecurityHostsHttpsOAS3

+ const OwaspStringLimit

+ const OwaspStringRestricted

+ const SpectralOwasp

+ const VacuumOwasp

+ func GetAllOWASPRules() map[string]*model.Rule

+ func GetOWASPArrayLimitRule() *model.Rule

+ func GetOWASPAuthInsecureSchemesRule() *model.Rule

+ func GetOWASPConstrainedAdditionalPropertiesRule() *model.Rule

+ func GetOWASPDefineErrorResponses401Rule() *model.Rule

+ func GetOWASPDefineErrorResponses429Rule() *model.Rule

+ func GetOWASPDefineErrorResponses500Rule() *model.Rule

+ func GetOWASPDefineErrorValidationRule() *model.Rule

+ func GetOWASPIntegerFormatRule() *model.Rule

+ func GetOWASPIntegerLimitLegacyRule() *model.Rule

+ func GetOWASPIntegerLimitRule() *model.Rule

+ func GetOWASPJWTBestPracticesRule() *model.Rule

+ func GetOWASPNoAPIKeysInURLRule() *model.Rule

+ func GetOWASPNoAdditionalPropertiesRule() *model.Rule

+ func GetOWASPNoCredentialsInURLRule() *model.Rule

+ func GetOWASPNoHttpBasicRule() *model.Rule

+ func GetOWASPNoNumericIDsRule() *model.Rule

+ func GetOWASPProtectionGlobalSafeRule() *model.Rule

+ func GetOWASPProtectionGlobalUnsafeRule() *model.Rule

+ func GetOWASPProtectionGlobalUnsafeStrictRule() *model.Rule

+ func GetOWASPRateLimitRetryAfterRule() *model.Rule

+ func GetOWASPRateLimitRule() *model.Rule

+ func GetOWASPSecurityHostsHttpsOAS2Rule() *model.Rule

+ func GetOWASPSecurityHostsHttpsOAS3Rule() *model.Rule

+ func GetOWASPStringLimitRule() *model.Rule

+ func GetOWASPStringRestrictedRule() *model.Rule

+ func GetRecommendedOWASPRules() map[string]*model.Rule

May 1, 2023

Changes in this version

+ const ComponentDescription

+ const ContactProperties

+ const DescriptionDuplication

+ const DuplicatedEntryInEnum

+ const InfoContact

+ const InfoDescription

+ const InfoLicense

+ const LicenseUrl

+ const NoAmbiguousPathsRule

+ const NoEvalInMarkdown

+ const NoRefSiblings

+ const NoScriptTagsInMarkdown

+ const NoVerbsInPath

+ const Oas2APIHost

+ const Oas2APISchemes

+ const Oas2AnyOf

+ const Oas2Discriminator

+ const Oas2HostNotExample

+ const Oas2HostTrailingSlash

+ const Oas2OneOf

+ const Oas2OperationFormDataConsumeCheck

+ const Oas2OperationSecurityDefined

+ const Oas2ParameterDescription

+ const Oas2Schema

+ const Oas2UnusedDefinition

+ const Oas2ValidSchemaExample

+ const Oas3APIServers

+ const Oas3HostNotExample

+ const Oas3HostTrailingSlash

+ const Oas3OperationSecurityDefined

+ const Oas3ParameterDescription

+ const Oas3Schema

+ const Oas3UnusedComponent

+ const Oas3ValidSchemaExample

+ const OpenAPITags

+ const OpenAPITagsAlphabetical

+ const OperationDescription

+ const OperationErrorResponse

+ const OperationOperationId

+ const OperationOperationIdUnique

+ const OperationOperationIdValidInUrl

+ const OperationParameters

+ const OperationSingularTag

+ const OperationSuccessResponse

+ const OperationTagDefined

+ const OperationTags

+ const PathDeclarationsMustExist

+ const PathKeysNoTrailingSlash

+ const PathNotIncludeQuery

+ const PathParamsRule

+ const PathsKebabCase

+ const Style

+ const TagDescription

+ const TypedEnum

+ const Validation

+ func GetAllBuiltInRules() map[string]*model.Rule

type RuleSet

+ func CreateRuleSetFromRuleMap(rules map[string]*model.Rule) *RuleSet

+ func GenerateDefaultOpenAPIRuleSet() *RuleSet

Jul 19, 2022

Changes in this version

+ func GetNoVerbsInPathRule() *model.Rule

+ func GetOperationErrorResponseRule() *model.Rule

+ func GetPathsKebabCaseRule() *model.Rule

Jul 16, 2022

Changes in this version

+ func NoAmbiguousPaths() *model.Rule

Jul 6, 2022

Changes in this version

+ func GetOAS3HostTrailingSlashRule() *model.Rule

May 13, 2022

Changes in this version

+ const SpectralAll

+ const SpectralOff

+ const SpectralOpenAPI

+ const SpectralRecommended

+ var AllOperationsPath = fmt.Sprintf("%s%s", allPaths, allOperations)

+ func GetAPIServersRule() *model.Rule

+ func GetComponentDescriptionsRule() *model.Rule

+ func GetContactPropertiesRule() *model.Rule

+ func GetDescriptionDuplicationRule() *model.Rule

+ func GetDuplicatedEntryInEnumRule() *model.Rule

+ func GetGlobalOperationTagsRule() *model.Rule

+ func GetInfoContactRule() *model.Rule

+ func GetInfoDescriptionRule() *model.Rule

+ func GetInfoLicenseRule() *model.Rule

+ func GetInfoLicenseUrlRule() *model.Rule

+ func GetNoEvalInMarkdownRule() *model.Rule

+ func GetNoRefSiblingsRule() *model.Rule

+ func GetNoScriptTagsInMarkdownRule() *model.Rule

+ func GetOAS2APIHostRule() *model.Rule

+ func GetOAS2APISchemesRule() *model.Rule

+ func GetOAS2DiscriminatorRule() *model.Rule

+ func GetOAS2ExamplesRule() *model.Rule

+ func GetOAS2FormDataConsumesRule() *model.Rule

+ func GetOAS2HostNotExampleRule() *model.Rule

+ func GetOAS2HostTrailingSlashRule() *model.Rule

+ func GetOAS2ParameterDescriptionRule() *model.Rule

+ func GetOAS2PolymorphicAnyOfRule() *model.Rule

+ func GetOAS2PolymorphicOneOfRule() *model.Rule

+ func GetOAS2SchemaRule() *model.Rule

+ func GetOAS2SecurityDefinedRule() *model.Rule

+ func GetOAS2UnusedComponentRule() *model.Rule

+ func GetOAS3ExamplesRule() *model.Rule

+ func GetOAS3HostNotExampleRule() *model.Rule

+ func GetOAS3ParameterDescriptionRule() *model.Rule

+ func GetOAS3SchemaRule() *model.Rule

+ func GetOAS3SecurityDefinedRule() *model.Rule

+ func GetOAS3UnusedComponentRule() *model.Rule

+ func GetOpenApiTagsAlphabeticalRule() *model.Rule

+ func GetOpenApiTagsRule() *model.Rule

+ func GetOperationDescriptionRule() *model.Rule

+ func GetOperationIdRule() *model.Rule

+ func GetOperationIdUniqueRule() *model.Rule

+ func GetOperationIdValidInUrlRule() *model.Rule

+ func GetOperationParametersRule() *model.Rule

+ func GetOperationSingleTagRule() *model.Rule

+ func GetOperationSuccessResponseRule() *model.Rule

+ func GetOperationTagsRule() *model.Rule

+ func GetPathDeclarationsMustExistRule() *model.Rule

+ func GetPathNoTrailingSlashRule() *model.Rule

+ func GetPathNotIncludeQueryRule() *model.Rule

+ func GetPathParamsRule() *model.Rule

+ func GetTagDescriptionRequiredRule() *model.Rule

+ func GetTypedEnumRule() *model.Rule

+ func LoadRulesetSchema() gojsonschema.JSONLoader

+ type RuleSet struct

+ Description string

+ DocumentationURI string

+ Extends interface{}

+ Formats []string

+ RuleDefinitions map[string]interface{}

+ Rules map[string]*model.Rule

+ func CreateRuleSetFromData(data []byte) (*RuleSet, error)

+ func CreateRuleSetUsingJSON(jsonData []byte) (*RuleSet, error)

+ func (rs *RuleSet) GetExtendsValue() map[string]string

+ type RuleSets interface

+ GenerateOpenAPIDefaultRuleSet func() *RuleSet

+ GenerateOpenAPIRecommendedRuleSet func() *RuleSet

+ GenerateRuleSetFromSuppliedRuleSet func(config *RuleSet) *RuleSet

+ func BuildDefaultRuleSets() RuleSets