jsonschema

Documentation

Overview

Package jsonschema has functionality related to json schema support.

Index

• func ConvertStringToType(s string, t Type) (any, error)
• func EnsureType(t Type, v any) (any, error)
• func Validate(s Schema, input map[string]any) error
• type ErrSchemaValidation
  • func NewErrSchemaValidation(path []string, msg string) ErrSchemaValidation
  • func (err ErrSchemaValidation) Error() string
• type ErrSchemaValidationArray
  • func (err ErrSchemaValidationArray) Error() string
• type ErrTypeMismatch
  • func NewErrTypeMismatch(act, exp any) ErrTypeMismatch
  • func (err ErrTypeMismatch) Error() string
• type Schema
• type Type
  • func TypeFromString(t string) Type
  • func (t *Type) UnmarshalYAML(n *yaml.Node) (err error)

Functions

func ConvertStringToType

func ConvertStringToType(s string, t Type) (any, error)

ConvertStringToType converts a string value to jsonschema type.

func EnsureType

func EnsureType(t Type, v any) (any, error)

EnsureType checks if the given value v respects json schema type t. Returns a type default value if v is nil. Error is returned on type mismatch or type not implemented.

func Validate

func Validate(s Schema, input map[string]any) error

Validate checks if input complies with given schema.

Types

type ErrSchemaValidation

type ErrSchemaValidation struct {
	// Path is a key path to the property.
	Path []string
	// Msg is an error message.
	Msg string
	// contains filtered or unexported fields
}

ErrSchemaValidation is a validation error.

func NewErrSchemaValidation

func NewErrSchemaValidation(path []string, msg string) ErrSchemaValidation

NewErrSchemaValidation creates a new error.

func (ErrSchemaValidation) Error

func (err ErrSchemaValidation) Error() string

Error implements error interface.

type ErrSchemaValidationArray

type ErrSchemaValidationArray []ErrSchemaValidation

ErrSchemaValidationArray is an array of validation errors.

func (ErrSchemaValidationArray) Error

func (err ErrSchemaValidationArray) Error() string

Error implements error interface.

type ErrTypeMismatch

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

ErrTypeMismatch is an error when expected jsonschema type and given values mismatch.

func NewErrTypeMismatch

func NewErrTypeMismatch(act, exp any) ErrTypeMismatch

NewErrTypeMismatch constructs new ErrTypeMismatch.

func (ErrTypeMismatch) Error

func (err ErrTypeMismatch) Error() string

Error implements error interface.

type Schema

type Schema struct {
	ID          string   `json:"$id,omitempty"`
	Schema      string   `json:"$schema,omitempty"`
	Title       string   `json:"title"`
	Description string   `json:"description"`
	Type        Type     `json:"type"`
	Required    []string `json:"required"`
	// @todo make a recursive type of properties.
	Properties map[string]any `json:"properties"`
}

Schema is a json schema definition. It doesn't implement all and may not comply fully. See https://json-schema.org/specification.html

type Type

type Type string

Type is a json schema type.

const (
	String      Type = "string"
	Number      Type = "number"
	Integer     Type = "integer"
	Boolean     Type = "boolean"
	Null        Type = "null"
	Object      Type = "object"
	Array       Type = "array"
	Unsupported Type = "UNSUPPORTED"
)

Json schema types.

func TypeFromString

func TypeFromString(t string) Type

TypeFromString creates a Type with enum validation.

func (*Type) UnmarshalYAML

func (t *Type) UnmarshalYAML(n *yaml.Node) (err error)

UnmarshalYAML implements yaml.Unmarshaler to parse Json Schema type.