validator

Documentation

Index

• Variables
• type InheritNonExistingTagError
  • func (i InheritNonExistingTagError) Error() string
• type InvalidTypeError
  • func (i InvalidTypeError) Error() string
• type UnknownPathError
  • func (u UnknownPathError) Error() string
• type UnknownRuleError
  • func (u UnknownRuleError) Error() string
• type Validator
  • func NewValidator(referenceType reflect.Type) (*Validator, error)
  • func (v *Validator) RegisterRule(key string, rule rule.Rule) error
  • func (v *Validator) UseReference(referenceType reflect.Type) error
  • func (v Validator) Validate(operationSpec operation.Spec) error

Variables

var (
	ErrMissingPrefix     = errors.New("missing tag prefix '" + prefix + "'")
	ErrDuplicateRuleTags = errors.New("tag name already registered")
	ErrNilRule           = errors.New("rule is nil")
	ErrReferenceIsNil    = errors.New("reference is nil")
)

Types

type InheritNonExistingTagError

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

InheritNonExistingTagError indicate that defined heredity does not exist.

func (InheritNonExistingTagError) Error

func (i InheritNonExistingTagError) Error() string

type InvalidTypeError

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

InvalidTypeError indicate that a type is invalid.

func (InvalidTypeError) Error

func (i InvalidTypeError) Error() string

type UnknownPathError

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

UnknownPathError indicate that defined path does not exist.

func (UnknownPathError) Error

func (u UnknownPathError) Error() string

type UnknownRuleError

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

UnknownRuleError indicate that requested rule is not known.

func (UnknownRuleError) Error

func (u UnknownRuleError) Error() string

type Validator

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

Validator interprets reference to validate JSON patch operations.

func NewValidator

func NewValidator(referenceType reflect.Type) (*Validator, error)

NewValidator create a new instance of validator using given reference.

func (*Validator) RegisterRule

func (v *Validator) RegisterRule(key string, rule rule.Rule) error

RegisterRule register addition rule for specific key (must have prefix `jp_`).

func (*Validator) UseReference

func (v *Validator) UseReference(referenceType reflect.Type) error

UseReference interpret given reference to model rule set.

func (Validator) Validate

func (v Validator) Validate(operationSpec operation.Spec) error

Validate a given JSON patch operations again rules.