validation

Documentation

Index

• type Error
  • func NewFieldInvalidValue(field string) Error
  • func NewFieldInvalidValueWithReason(field, reason string) Error
  • func NewFieldRequired(field string) Error
  • func ValidateConfig(config *api.Config) []Error
  • func (v Error) Error() string
• type ErrorType

Types

type Error

type Error struct {
	Type   ErrorType
	Field  string
	Reason string
}

Error is an implementation of the 'error' interface, which represents an error of validation.

func NewFieldInvalidValue

func NewFieldInvalidValue(field string) Error

NewFieldInvalidValue returns a ValidationError indicating "invalid value"

func NewFieldInvalidValueWithReason

func NewFieldInvalidValueWithReason(field, reason string) Error

NewFieldInvalidValueWithReason returns a ValidationError indicating "invalid value" and a reason for the error

func NewFieldRequired

func NewFieldRequired(field string) Error

NewFieldRequired returns a *ValidationError indicating "value required"

func ValidateConfig

func ValidateConfig(config *api.Config) []Error

ValidateConfig returns a list of error from validation.

func (Error) Error

func (v Error) Error() string

type ErrorType

type ErrorType string

ErrorType is a machine readable value providing more detail about why a field is invalid.

const (
	// ErrorTypeRequired is used to report required values that are not provided
	// (e.g. empty strings, null values, or empty arrays).
	ErrorTypeRequired ErrorType = "FieldValueRequired"

	// ErrorInvalidValue is used to report values that do not conform to the
	// expected schema.
	ErrorInvalidValue ErrorType = "InvalidValue"
)