validation

Documentation

Index

• type ValidationError
  • func NewFieldInvalidValue(field string) ValidationError
  • func NewFieldRequired(field string) ValidationError
  • func ValidateConfig(config *api.Config) []ValidationError
  • func (v ValidationError) Error() string
• type ValidationErrorType

Types

type ValidationError

type ValidationError struct {
	Type  ValidationErrorType
	Field string
}

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

func NewFieldInvalidValue

func NewFieldInvalidValue(field string) ValidationError

NewFieldInvalidValue returns a ValidationError indicating "invalid value"

func NewFieldRequired

func NewFieldRequired(field string) ValidationError

NewFieldRequired returns a *ValidationError indicating "value required"

func ValidateConfig

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

ValidateConfig returns a list of error from validation.

func (ValidationError) Error

func (v ValidationError) Error() string

type ValidationErrorType

type ValidationErrorType string

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

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

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