schema

Documentation

Index

• Constants
• func ReadAndValidate(r io.Reader) ([]byte, error)
• func Set(s *Schema)
• func Validate(r io.Reader) error
• func ValidateData(data []byte) error
• func ValidateFile(path string) error
• func ValidateType(obj interface{}) error
• type Error
  • func (e *Error) Error() string
• type Schema
  • func BuiltinSchema() *Schema
  • func Get() *Schema
  • func Load(source string) (*Schema, error)
  • func NopSchema() *Schema
  • func (s *Schema) ReadAndValidate(r io.Reader) ([]byte, error)
  • func (s *Schema) Validate(r io.Reader) error
  • func (s *Schema) ValidateData(data []byte) error
  • func (s *Schema) ValidateFile(path string) error
  • func (s *Schema) ValidateType(obj interface{}) error

Constants

const (
	// BuiltinSchemaName names the builtin schema for Load()/Set().
	BuiltinSchemaName = "builtin"
	// NoneSchemaName names the NOP-schema for Load()/Set().
	NoneSchemaName = "none"
)

Functions

func ReadAndValidate

func ReadAndValidate(r io.Reader) ([]byte, error)

ReadAndValidate all data from the given reader, using the active schema for validation.

func Set

func Set(s *Schema)

Set sets the default validating JSON schema.

func Validate

func Validate(r io.Reader) error

Validate validates the data read from an io.Reader against the active schema.

func ValidateData

func ValidateData(data []byte) error

ValidateData validates the given JSON document against the active schema.

func ValidateFile

func ValidateFile(path string) error

ValidateFile validates the given JSON file against the active schema.

func ValidateType

func ValidateType(obj interface{}) error

ValidateType validates a go object against the schema.

Types

type Error

type Error struct {
	Result *schema.Result
}

Error wraps a JSON validation result.

func (*Error) Error

func (e *Error) Error() string

Error returns the given Result's errors as a single error string.

type Schema

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

Schema is a JSON validation schema.

func BuiltinSchema

func BuiltinSchema() *Schema

BuiltinSchema returns the builtin schema if we have a valid one. Otherwise it falls back to NopSchema().

func Get

func Get() *Schema

Get returns the active validating JSON schema.

func Load

func Load(source string) (*Schema, error)

Load the given JSON Schema.

func NopSchema

func NopSchema() *Schema

NopSchema returns an validating JSON Schema that does no real validation.

func (*Schema) ReadAndValidate

func (s *Schema) ReadAndValidate(r io.Reader) ([]byte, error)

ReadAndValidate all data from the given reader, using the schema for validation.

func (*Schema) Validate

func (s *Schema) Validate(r io.Reader) error

Validate validates the data read from an io.Reader against the schema.

func (*Schema) ValidateData

func (s *Schema) ValidateData(data []byte) error

ValidateData validates the given JSON data against the schema.

func (*Schema) ValidateFile

func (s *Schema) ValidateFile(path string) error

ValidateFile validates the given JSON file against the schema.

func (*Schema) ValidateType

func (s *Schema) ValidateType(obj interface{}) error

ValidateType validates a go object against the schema.