openapi

README

Checks openapi spec:

• Enum values have to be started with a Capital letter
• Enum values have to be unique
• some keys should not have a default value

Documentation

Index

• Constants
• func GetOpenAPIYAMLFiles(rootPath string) ([]string, error)
• func RunOpenAPIValidator(fileC chan fileValidation, cfg *config.OpenAPISettings) chan fileValidation
• type OpenAPI
  • func New(cfg *config.OpenAPISettings) *OpenAPI
  • func (o *OpenAPI) Desc() string
  • func (o *OpenAPI) Name() string
  • func (o *OpenAPI) Run(m *module.Module) (errors.LintRuleErrorsList, error)

Constants

const (
	ID = "openapi"
)

Functions

func GetOpenAPIYAMLFiles

func GetOpenAPIYAMLFiles(rootPath string) ([]string, error)

GetOpenAPIYAMLFiles returns all .yaml files which are placed into openapi/ | crds/ directory

func RunOpenAPIValidator

func RunOpenAPIValidator(fileC chan fileValidation, cfg *config.OpenAPISettings) chan fileValidation

RunOpenAPIValidator runs validator, get channel with file paths and returns channel with results

Types

type OpenAPI

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

OpenAPI linter

func New

func New(cfg *config.OpenAPISettings) *OpenAPI

func (*OpenAPI) Desc

func (o *OpenAPI) Desc() string

func (*OpenAPI) Name

func (o *OpenAPI) Name() string

func (*OpenAPI) Run

func (o *OpenAPI) Run(m *module.Module) (errors.LintRuleErrorsList, error)