lint

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
  • func InfoCheck(source string, spec *load.SpecInfo) []*Error
  • func PathParamsCheck(source string, s *load.SpecInfo) []*Error
  • func RequiredParamsCheck(source string, s *load.SpecInfo) []*Error
  • func SchemaCheck(source string, spec *load.SpecInfo) []*Error
• type Errors
  • func Run(config *Config, source string, spec *load.SpecInfo) Errors
  • func (e Errors) Len() int
  • func (e Errors) Less(i, j int) bool
  • func (e Errors) Swap(i, j int)

Constants

const (
	LEVEL_ERROR = 0
	LEVEL_WARN  = 1
)

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)