schema

package

v0.3.1 Latest Latest Go to latest Published: Mar 21, 2022 License: Apache-2.0 Imports: 12 Imported by: 0

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

Constants ¶

const (
	// BuiltinSchemaName references the builtin schema for Load()/Set().
	BuiltinSchemaName = "builtin"
	// NoneSchemaName references a disabled/NOP schema for Load()/Set().
	NoneSchemaName = "none"
	// DefaultSchemaName is the none schema.
	DefaultSchemaName = NoneSchemaName
)

Variables ¶

This section is empty.

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 error as a multierror(.Error()).

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 validating JSON Schema.

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.

Source Files ¶

View all Source files

schema.go

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