validation

package
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 16, 2019 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Error added in v1.1.3

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 added in v1.0.4

func NewFieldInvalidValue(field string) Error

NewFieldInvalidValue returns a ValidationError indicating "invalid value"

func NewFieldInvalidValueWithReason added in v1.1.9

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 added in v1.1.3

func (v Error) Error() string

type ErrorType added in v1.1.3

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"
)

Jump to

Keyboard shortcuts

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