yamlvalidator

package module

Go to main page

Versions in this module

v1

v1.2.0

Oct 17, 2026

Changes in this version

+ const FieldNamingGo

+ const FieldNamingYAML

+ type FieldNaming = engine.FieldNaming

v1.1.0

Sep 28, 2026

Changes in this version

+ func Marshal(in any) ([]byte, error)

+ func Unmarshal(data []byte, out any) error

+ type KeyValidatorFactory = engine.KeyValidatorFactory

+ type Limits = engine.Limits

+ type MarshalOptions = engine.MarshalOptions

+ type Registry = engine.Registry

+ func NewRegistry(config RegistryConfig) (*Registry, error)

+ type RegistryConfig = engine.RegistryConfig

+ type SchemaError = engine.SchemaError

+ type TypeBinding = engine.TypeBinding

+ type UnmarshalOptions = engine.UnmarshalOptions

+ type ValidationErrors = engine.ValidationErrors

+ type ValueValidatorFactory = engine.ValueValidatorFactory

v1.0.0

Sep 24, 2026

v0

v0.6.0

Sep 24, 2026

Changes in this version

+ func AppendIndexPath(base string, index int) (string, error)

+ func AppendPropertyPath(base, property string) string

type JSONSchemaCompileOptions

+ ContentEncodings []JSONSchemaContentEncoding

+ ContentMediaTypes []JSONSchemaContentMediaType

+ type JSONSchemaContentEncoding struct

+ Decode func(string) ([]byte, error)

+ Name string

+ type JSONSchemaContentMediaType struct

+ Name string

+ UnmarshalJSON func([]byte) (any, error)

+ Validate func([]byte) error

type JSONSchemaVocabulary

+ Schema []byte

type NodeType

+ func InferNodeType(node *yaml.Node, ctx *ValidationContext) NodeType

v0.5.0

Sep 24, 2026

Changes in this version

+ var ErrJSONSchemaResourceNotFound = errors.New("JSON Schema resource not found")

+ var ErrJSONSchemaResourceOutsideRoot = errors.New("JSON Schema resource is outside resolver root")

type FieldSchema

+ func CompileJSONSchemaContext(ctx context.Context, data []byte) (*FieldSchema, error)

+ func CompileJSONSchemaContextWithOptions(ctx context.Context, data []byte, opts JSONSchemaCompileOptions) (*FieldSchema, error)

+ type JSONSchemaCachingResolver struct

+ Resolver JSONSchemaResolver

+ func NewJSONSchemaCachingResolver(resolver JSONSchemaResolver) *JSONSchemaCachingResolver

+ func (resolver *JSONSchemaCachingResolver) Resolve(ctx context.Context, resourceURL string) ([]byte, error)

type JSONSchemaCompileOptions

+ Resolver JSONSchemaResolver

+ type JSONSchemaFileResolver struct

+ func NewJSONSchemaFileResolver(root string) (*JSONSchemaFileResolver, error)

+ func (resolver *JSONSchemaFileResolver) Resolve(ctx context.Context, resourceURL string) ([]byte, error)

type JSONSchemaKeyword

+ CompileWithContext JSONSchemaKeywordCompileContextFunc

+ Subschemas []JSONSchemaSubschemaPath

+ type JSONSchemaKeywordCompileContext struct

+ func (ctx *JSONSchemaKeywordCompileContext) Reference(ref string) (*JSONSchemaSubschema, error)

+ func (ctx *JSONSchemaKeywordCompileContext) Subschema(path ...string) *JSONSchemaSubschema

+ type JSONSchemaKeywordCompileContextFunc func(ctx *JSONSchemaKeywordCompileContext, keywordValue any) (JSONSchemaKeywordValidateFunc, error)

type JSONSchemaKeywordValidationContext

+ func (ctx *JSONSchemaKeywordValidationContext) ValidateSubschema(schema *JSONSchemaSubschema, instance any, relativePath []string) bool

+ type JSONSchemaResolver interface

+ Resolve func(ctx context.Context, url string) ([]byte, error)

+ type JSONSchemaResolverChain []JSONSchemaResolver

+ func (chain JSONSchemaResolverChain) Resolve(ctx context.Context, resourceURL string) ([]byte, error)

+ type JSONSchemaResolverFunc func(context.Context, string) ([]byte, error)

+ func (f JSONSchemaResolverFunc) Resolve(ctx context.Context, url string) ([]byte, error)

+ type JSONSchemaResourceMap map[string][]byte

+ func (m JSONSchemaResourceMap) Resolve(ctx context.Context, resourceURL string) ([]byte, error)

+ type JSONSchemaSubschema struct

+ type JSONSchemaSubschemaPath []JSONSchemaSubschemaPosition

+ type JSONSchemaSubschemaPosition struct

+ func JSONSchemaSubschemaAllItems() JSONSchemaSubschemaPosition

+ func JSONSchemaSubschemaAllProperties() JSONSchemaSubschemaPosition

+ func JSONSchemaSubschemaItem(index int) JSONSchemaSubschemaPosition

+ func JSONSchemaSubschemaProperty(name string) JSONSchemaSubschemaPosition

type Validator

+ func (v *Validator) ValidateReader(reader io.Reader) (*ValidationResult, error)

+ func (v *Validator) ValidateReaderContext(runCtx context.Context, reader io.Reader) (*ValidationResult, error)

+ func (v *Validator) ValidateReaderContextWithOptions(runCtx context.Context, reader io.Reader, opts ValidationContext) (*ValidationResult, error)

+ func (v *Validator) ValidateReaderWithOptions(reader io.Reader, opts ValidationContext) (*ValidationResult, error)

v0.4.0

Sep 24, 2026

Changes in this version

+ func FormatPathTokens(tokens []PathToken) string

+ type DependencyDetails struct

+ Field string

+ Trigger string

+ type ItemCountDetails struct

+ Actual int

+ Bound int

+ type KeyValidatorCloner interface

+ CloneKeyValidator func() KeyValidator

+ type NumericRangeDetails struct

+ Bound string

+ Value string

+ type PathToken struct

+ Index int

+ Kind PathTokenKind

+ Name string

+ func ParsePathTokens(path string) ([]PathToken, error)

+ type PathTokenKind string

+ const PathTokenDocument

+ const PathTokenIndex

+ const PathTokenProperty

+ type RequiredDetails struct

+ Field string

+ type TypeMismatchDetails struct

+ Actual string

+ Expected []string

+ type UnknownKeyDetails struct

+ Key string

+ Suggestion string

type ValidationContext

+ func (ctx *ValidationContext) Context() context.Context

+ func (ctx *ValidationContext) ContextErr() error

type ValidationError

+ Details any

+ PathTokens []PathToken

type ValidationResult

+ Canceled bool

+ ContextErr error

type Validator

+ func (v *Validator) ValidateContext(runCtx context.Context, data []byte) (*ValidationResult, error)

+ func (v *Validator) ValidateContextWithOptions(runCtx context.Context, data []byte, opts ValidationContext) (*ValidationResult, error)

+ type ValueValidatorCloner interface

+ CloneValueValidator func() ValueValidator

v0.3.1

Sep 24, 2026

v0.3.0

Sep 24, 2026

Changes in this version

+ func ValidateFieldSchema(schema *FieldSchema) error

+ type DefinitionValidator interface

+ ValidateDefinition func() error

type FieldSchema

+ AllowedTypes []NodeType

+ AnyOfSchemas []*FieldSchema

+ DependentRequired map[string][]string

+ ForbiddenTogether [][]string

+ OneOfRequired [][]string

+ OneOfSchemas []*FieldSchema

+ func CompileJSONSchema(data []byte) (*FieldSchema, error)

+ func CompileJSONSchemaWithOptions(data []byte, opts JSONSchemaCompileOptions) (*FieldSchema, error)

+ type JSONSchemaCompileOptions struct

+ AdditionalPropertiesFalsePolicy *UnknownKeyPolicy

+ AssertContent bool

+ AssertFormat bool

+ AssertVocabs bool

+ ConfigureCompiler func(*jsonschema.Compiler) error

+ DefaultDraft JSONSchemaDraft

+ Formats []JSONSchemaFormat

+ Keywords []JSONSchemaKeyword

+ LoadURL JSONSchemaLoadFunc

+ RegexpTimeout time.Duration

+ Resources map[string][]byte

+ SchemaURL string

+ Vocabularies []JSONSchemaVocabulary

+ type JSONSchemaDraft string

+ const JSONSchemaDraft2019

+ const JSONSchemaDraft2020

+ const JSONSchemaDraft4

+ const JSONSchemaDraft6

+ const JSONSchemaDraft7

+ type JSONSchemaFormat struct

+ Name string

+ Validate func(value any) error

+ type JSONSchemaKeyword struct

+ Compile JSONSchemaKeywordCompileFunc

+ Name string

+ Validate JSONSchemaKeywordFunc

+ type JSONSchemaKeywordCompileFunc func(keywordValue any) (JSONSchemaKeywordValidateFunc, error)

+ type JSONSchemaKeywordFunc func(keywordValue any, instance any, ctx *JSONSchemaKeywordValidationContext)

+ type JSONSchemaKeywordIssue struct

+ Message string

+ Path []string

+ type JSONSchemaKeywordValidateFunc func(instance any, ctx *JSONSchemaKeywordValidationContext)

+ type JSONSchemaKeywordValidationContext struct

+ func (ctx *JSONSchemaKeywordValidationContext) AddError(message string)

+ func (ctx *JSONSchemaKeywordValidationContext) AddErrorAt(path []string, message string)

+ func (ctx *JSONSchemaKeywordValidationContext) MarkItemEvaluated(index int)

+ func (ctx *JSONSchemaKeywordValidationContext) MarkPropertyEvaluated(name string)

+ type JSONSchemaLoadFunc func(url string) ([]byte, error)

+ type JSONSchemaVocabulary struct

+ Keywords []JSONSchemaKeyword

+ URL string

type ValidationContext

+ MaxBytes int

+ MaxDepth int

+ MaxDiagnostics int

+ MaxDocuments int

type ValidationError

+ Code string

+ SchemaPath string

type ValidationResult

+ Truncated bool

type Validator

+ func CompileFieldSchema(schema *FieldSchema) (*Validator, error)

v0.2.1

Mar 17, 2026

v0.1.0

Dec 24, 2025

Changes in this version

+ func FormatErrorWithSource(err ValidationError, lines []string) string

+ func Ptr[T any](v T) *T

+ func RenderLineWithCaret(line string, byteCol int) (string, int, int)

+ type ConditionalRule struct

+ ConditionField string

+ ConditionValue string

+ ThenForbidden []string

+ ThenRequired []string

+ type ErrorCollector struct

+ func NewErrorCollector() *ErrorCollector

+ func (c *ErrorCollector) Add(err ValidationError)

+ func (c *ErrorCollector) All() []ValidationError

+ func (c *ErrorCollector) Errors() []ValidationError

+ func (c *ErrorCollector) HasErrors() bool

+ func (c *ErrorCollector) Warnings() []ValidationError

+ type ErrorLevel int

+ const LevelError

+ const LevelWarning

+ func (l ErrorLevel) String() string

+ type FieldSchema struct

+ AdditionalProperties *FieldSchema

+ AllowedKeys map[string]*FieldSchema

+ AnyOf [][]string

+ Conditions []ConditionalRule

+ Default interface{}

+ Deprecated string

+ Description string

+ ExactlyOneOf []string

+ ItemSchema *FieldSchema

+ KeyValidators []KeyValidator

+ MaxItems *int

+ MinItems *int

+ MutuallyExclusive []string

+ Nullable bool

+ Required bool

+ Type NodeType

+ UnknownKeyPolicy UnknownKeyPolicy

+ Validators []ValueValidator

+ type KeyValidator interface

+ ValidateKey func(key string, keyNode *yaml.Node, path string, ctx *ValidationContext)

+ type NodeType int

+ const TypeAny

+ const TypeBool

+ const TypeFloat

+ const TypeInt

+ const TypeMap

+ const TypeNull

+ const TypeSequence

+ const TypeString

+ func (t NodeType) String() string

+ type UnknownKeyPolicy int

+ const UnknownKeyError

+ const UnknownKeyIgnore

+ const UnknownKeyInherit

+ const UnknownKeyWarn

+ type ValidationContext struct

+ SourceLines []string

+ StopOnFirst bool

+ StrictKeys bool

+ StrictTypes bool

+ YAML11Booleans bool

+ func NewValidationContext() *ValidationContext

+ func (ctx *ValidationContext) AddError(err ValidationError)

+ func (ctx *ValidationContext) Collector() *ErrorCollector

+ func (ctx *ValidationContext) IsStopped() bool

+ type ValidationError struct

+ Column int

+ Expected string

+ Got string

+ Level ErrorLevel

+ Line int

+ Message string

+ Path string

+ func (e ValidationError) Error() string

+ type ValidationResult struct

+ Collector *ErrorCollector

+ SourceLines []string

+ func (r *ValidationResult) FormatAll(sortByPos bool) string

+ func (r *ValidationResult) HasErrors() bool

+ func (r *ValidationResult) SortByPosition()

+ type Validator struct

+ func NewValidator(schema *FieldSchema) *Validator

+ func (v *Validator) InferTypeForPublic(node *yaml.Node, ctx *ValidationContext) NodeType

+ func (v *Validator) ValidateBytes(data []byte) *ValidationResult

+ func (v *Validator) ValidateWithOptions(data []byte, opts ValidationContext) *ValidationResult

+ type ValueValidator interface

+ Validate func(node *yaml.Node, path string, ctx *ValidationContext)

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