linter

Documentation

Index

• Variables
• func DefinitionNamingConvention(convention NamingConvention) core.DocumentVisitor
• func GetNamingChecker(convention NamingConvention) func(string) bool
• func NoEmptyDescriptions() core.DocumentVisitor
• func NoEmptyOperationID() core.DocumentVisitor
• func OperationTagNamingConvention(convention NamingConvention) core.DocumentVisitor
• func ParameterNamingConvention(convention NamingConvention) core.DocumentVisitor
• func PathNamingConvention(convention NamingConvention) core.DocumentVisitor
• func PropertyNamingConvention(convention NamingConvention) core.DocumentVisitor
• func RequireOperationTags() core.DocumentVisitor
• func RunSpecLint(options Options)
• func SlashTerminatedPaths() core.DocumentVisitor
• type Config
  • func LoadConfig(path string) (*Config, error)
• type DefinitionNamingConventionOpts
• type NamingConvention
• type NoEmptyDescriptionsOpts
• type OperationTagNamingConventionOpts
• type Options
• type ParameterNamingConventionOpts
• type PathNamingConventionOpts
• type PropertyNamingConventionOpts
• type Rules

Variables

var PresetStandard = Rules{
	NoEmptyDescriptions: &NoEmptyDescriptionsOpts{
		IgnoreProperties: true,
		IgnoreParameters: true,
	},
	NoEmptyOperationID:   true,
	RequireOperationTags: true,
	DefinitionNamingConvention: &DefinitionNamingConventionOpts{
		Convention: PascalCase,
	},
	OperationTagNamingConvention: &OperationTagNamingConventionOpts{
		Convention: CamelCase,
	},
}

Functions

func DefinitionNamingConvention

func DefinitionNamingConvention(convention NamingConvention) core.DocumentVisitor

func GetNamingChecker

func GetNamingChecker(convention NamingConvention) func(string) bool

func NoEmptyDescriptions

func NoEmptyDescriptions() core.DocumentVisitor

func NoEmptyOperationID

func NoEmptyOperationID() core.DocumentVisitor

func OperationTagNamingConvention

func OperationTagNamingConvention(convention NamingConvention) core.DocumentVisitor

func ParameterNamingConvention

func ParameterNamingConvention(convention NamingConvention) core.DocumentVisitor

func PathNamingConvention

func PathNamingConvention(convention NamingConvention) core.DocumentVisitor

func PropertyNamingConvention

func PropertyNamingConvention(convention NamingConvention) core.DocumentVisitor

func RequireOperationTags

func RequireOperationTags() core.DocumentVisitor

func RunSpecLint

func RunSpecLint(options Options)

func SlashTerminatedPaths

func SlashTerminatedPaths() core.DocumentVisitor

Types

type Config

type Config struct {
	Rules   Rules    `yaml:"rules,omitempty"`
	Presets []string `yaml:"presets,omitempty"`
}

func LoadConfig

func LoadConfig(path string) (*Config, error)

type DefinitionNamingConventionOpts

type DefinitionNamingConventionOpts struct {
	Convention NamingConvention `yaml:"convention"`
}

type NamingConvention

type NamingConvention = string

const (
	PascalCase NamingConvention = "PascalCase"
	SnakeCase  NamingConvention = "SnakeCase"
	CamelCase  NamingConvention = "CamelCase"
	KebabCase  NamingConvention = "KebabCase"
)

type NoEmptyDescriptionsOpts

type NoEmptyDescriptionsOpts struct {
	IgnoreProperties bool `yaml:"ignoreProperties,omitempty"`
	IgnoreOperations bool `yaml:"ignoreOperations,omitempty"`
	IgnoreParameters bool `yaml:"ignoreParameters,omitempty"`
}

type OperationTagNamingConventionOpts

type OperationTagNamingConventionOpts struct {
	Convention NamingConvention `yaml:"convention"`
}

type Options

type Options struct {
	Spec string
}

type ParameterNamingConventionOpts

type ParameterNamingConventionOpts struct {
	Convention NamingConvention `yaml:"convention"`
}

type PathNamingConventionOpts

type PathNamingConventionOpts struct {
	Convention NamingConvention `yaml:"convention"`
}

type PropertyNamingConventionOpts

type PropertyNamingConventionOpts struct {
	Convention NamingConvention `yaml:"convention"`
}

type Rules

type Rules struct {
	NoEmptyDescriptions          *NoEmptyDescriptionsOpts          `yaml:"noEmptyDescriptions,omitempty"`
	NoEmptyOperationID           bool                              `yaml:"noEmptyOperationID,omitempty"`
	SlashTerminatedPaths         bool                              `yaml:"slashTerminatedPaths,omitempty"`
	RequireOperationTags         bool                              `yaml:"requireOperationTags,omitempty"`
	PathNamingConvention         *PathNamingConventionOpts         `yaml:"pathNamingConvention,omitempty"`
	DefinitionNamingConvention   *DefinitionNamingConventionOpts   `yaml:"definitionNamingConvention,omitempty"`
	PropertyNamingConvention     *PropertyNamingConventionOpts     `yaml:"propertyNamingConvention,omitempty"`
	ParameterNamingConvention    *ParameterNamingConventionOpts    `yaml:"parameterNamingConvention,omitempty"`
	OperationTagNamingConvention *OperationTagNamingConventionOpts `yaml:"operationTagNamingConvention,omitempty"`
}