openapi3lint

package

v1.7.2 Latest Latest Go to latest Published: Jun 15, 2021 License: MIT Imports: 23 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/grokify/spectrum

Links

Open Source Insights

README ¶

OpenAPI 3 Lint

This is a Go-based OpenAPI 3 spec linter.

Spectrum is designed to support a multi-file, multi-user, async editing process where linting reports need to be resilinent to mutiple changes to the specs occurring between the time the validation is run and resolved.

Why Spectrum Linter?

There are a few linters available.

The reasons this exists are:

written in Go so its easy to use/modify for Go devs
policy violations are grouped by rule, vs. line number for easier mitigation
policy violations are identified by JSON Schema pointere vs. line number for easier identification when using merged files

Standard Rules

The following rules are built into Spectrum.

datatype-int-format-standard-exist: ensures data types of integer have a standard format (int32 or int64)
operation-operationid-style-camelcase: ensures operationIds use camelCase
operation-operationid-style-kebabcase: ensures operationIds use kebab-case
operation-operationid-style-pascalcase: ensures operationIds use PascalCase
operation-operationid-style-snakecase: ensures operationIds use snake_case
operation-summary-exist ensures a summary exists.
operation-summary-style-first-uppercase: ensures summary starts with capitalized first character
path-param-style-camelcase: path parms are camel case
path-param-style-kebabcase: path parms are kebab case
path-param-style-pascalcase: path parms are Pascal case
path-param-style-snakecase: path parms are snake case
schema-has-reference: ensures schemas have references
schema-object-properties-exist: schema of type object have properties or additionalProperties defined
schema-property-enum-style-camelcase: schema property enums are camel case
schema-property-enum-style-kebabcase: schema property enums are kebab case
schema-property-enum-style-pascalcase: schema property enums are Pascal case
schema-property-enum-style-snakecase: schema property enums are snake case
schema-reference-has-schema: ensures schma JSON pointers reference existing schemas
tag-style-first-uppercase: Tag names have capitalized first character

Other Linters

There are other linters available. To date, Spectrum Linter hasn't beeen inspired by any of them, though there is a desire and effort to align on rule names and potentially rule definitions to achieve similar behavior.

Mermade OAS-Kit - https://github.com/mermade/oas-kit
1. https://mermade.github.io/oas-kit/default-rules.html
2. https://mermade.github.io/oas-kit/linter-rules.html
Spectral - https://github.com/stoplightio/spectral
1. Inspired by Speccy
Speccy - https://github.com/wework/speccy
1. Inspired by OAS-Kit

Documentation ¶

Index ¶

func RulesConfigExample1() map[string]RuleConfig
func ValidateRules(rules map[string]Rule) error
type EmptyRule
type Policy
type PolicyConfig
- func NewPolicyConfigFile(filename string) (PolicyConfig, error)
- func (polCfg *PolicyConfig) RuleNames() ([]string, []string, []string)
- func (cfg *PolicyConfig) StandardPolicy() (Policy, error)
type Rule
- func NewStandardRule(name, sev string) (Rule, error)
type RuleConfig
type RulesMap
type StandardRuleNames
- func NewStandardRuleNames() *StandardRuleNames
- func (srn *StandardRuleNames) Exists(ruleName string) bool
- func (srn *StandardRuleNames) Slice() []string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func RulesConfigExample1 ¶ added in v1.7.0

func RulesConfigExample1() map[string]RuleConfig

func ValidateRules ¶

func ValidateRules(rules map[string]Rule) error

Types ¶

type EmptyRule ¶ added in v1.7.0

type EmptyRule struct{}

func (EmptyRule) Name ¶ added in v1.7.0

func (rule EmptyRule) Name() string

func (EmptyRule) ProcessOperation ¶ added in v1.7.0

func (rule EmptyRule) ProcessOperation(spec *oas3.Swagger, op *oas3.Operation, opPointer, path, method string) []lintutil.PolicyViolation

func (EmptyRule) ProcessSpec ¶ added in v1.7.0

func (rule EmptyRule) ProcessSpec(spec *oas3.Swagger, pointerBase string) []lintutil.PolicyViolation

func (EmptyRule) Scope ¶ added in v1.7.0

func (rule EmptyRule) Scope() string

func (EmptyRule) Severity ¶ added in v1.7.0

func (rule EmptyRule) Severity() string

type Policy ¶

type Policy struct {
	// contains filtered or unexported fields
}

func (*Policy) AddRule ¶

func (pol *Policy) AddRule(rule Rule, errorOnCollision bool) error

func (*Policy) RuleNames ¶

func (pol *Policy) RuleNames() []string

func (*Policy) ValidateSpec ¶

func (pol *Policy) ValidateSpec(spec *oas3.Swagger, pointerBase, filterSeverity string) (*lintutil.PolicyViolationsSets, error)

type PolicyConfig ¶

type PolicyConfig struct {
	Name             string                `json:"name"`
	Version          string                `json:"version"`
	LastUpdated      time.Time             `json:"lastUpdated,omitempty"`
	Rules            map[string]RuleConfig `json:"rules,omitempty"`
	NonStandardRules []string              `json:"nonStandardRules,omitempty"`
}

func NewPolicyConfigFile ¶

func NewPolicyConfigFile(filename string) (PolicyConfig, error)

func (*PolicyConfig) RuleNames ¶ added in v1.7.1

func (polCfg *PolicyConfig) RuleNames() ([]string, []string, []string)

func (*PolicyConfig) StandardPolicy ¶

func (cfg *PolicyConfig) StandardPolicy() (Policy, error)

type Rule ¶

type Rule interface {
	Name() string
	Scope() string
	Severity() string
	ProcessSpec(spec *oas3.Swagger, pointerBase string) []lintutil.PolicyViolation
	ProcessOperation(spec *oas3.Swagger, op *oas3.Operation, opPointer, path, method string) []lintutil.PolicyViolation
}

func NewStandardRule ¶ added in v1.7.0

func NewStandardRule(name, sev string) (Rule, error)

type RuleConfig ¶

type RuleConfig struct {
	Severity string `json:"severity"`
}

type RulesMap ¶

type RulesMap map[string]Rule

type StandardRuleNames ¶ added in v1.7.0

type StandardRuleNames struct {
	// contains filtered or unexported fields
}

func NewStandardRuleNames ¶ added in v1.7.1

func NewStandardRuleNames() *StandardRuleNames

func (*StandardRuleNames) Exists ¶ added in v1.7.1

func (srn *StandardRuleNames) Exists(ruleName string) bool

func (*StandardRuleNames) Slice ¶ added in v1.7.1

func (srn *StandardRuleNames) Slice() []string

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
lintutil
openapi3lint1
cmd/oas3lint command
ruleintstdformat
ruleopidstyle
ruleopsummaryexist
ruleopsummarystylefirstuppercase
rulepathparamstyle
ruleschemaobjectpropsexist
ruleschemapropenumstyle
ruleschemareferences
ruletagstylefirstuppercase

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL