lint

package

v1.8.2 Latest Latest Go to latest Published: Sep 12, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/treeverse/oasdiff

Links

Open Source Insights

Documentation ¶

Overview ¶

Package lint provides a lint function for OpenAPI Spec 3.

Index ¶

Constants
type Check
type Config
- func DefaultConfig() *Config
- func NewConfig(checks []Check) *Config
type Error
type Errors
- func Run(config Config, source string, spec *load.SpecInfo) Errors

Constants ¶

View Source

const (
	LEVEL_ERROR = 0
	LEVEL_WARN  = 1
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Check ¶

type Check func(string, *load.SpecInfo) []*Error

type Config ¶

type Config struct {
	Checks []Check
}

func DefaultConfig ¶

func DefaultConfig() *Config

func NewConfig ¶

func NewConfig(checks []Check) *Config

type Error ¶

type Error struct {
	Id      string `json:"id,omitempty" yaml:"id,omitempty"`
	Text    string `json:"text,omitempty" yaml:"text,omitempty"`
	Comment string `json:"comment,omitempty" yaml:"comment,omitempty"`
	Level   int    `json:"level" yaml:"level"`
	Source  string `json:"source,omitempty" yaml:"source,omitempty"`
}

func InfoCheck ¶

func InfoCheck(source string, spec *load.SpecInfo) []*Error

InfoCheck based on REQUIRED fields (Version and Info) from swagger docs, see: https://swagger.io/docs/specification/api-general-info/

func PathParamsCheck ¶

func PathParamsCheck(source string, s *load.SpecInfo) []*Error

func RequiredParamsCheck ¶

func RequiredParamsCheck(source string, s *load.SpecInfo) []*Error

func SchemaCheck ¶

func SchemaCheck(source string, spec *load.SpecInfo) []*Error

type Errors ¶

type Errors []*Error

func Run ¶

func Run(config Config, source string, spec *load.SpecInfo) Errors

func (Errors) Len ¶

func (e Errors) Len() int

func (Errors) Less ¶

func (e Errors) Less(i, j int) bool

func (Errors) Swap ¶

func (e Errors) Swap(i, j int)

Source Files ¶

View all Source files

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