schemas

Documentation

Overview

Package schemas defines JSON schema types.

Code borrowed from https://github.com/alecthomas/jsonschema/

Copyright (C) 2014 Alec Thomas

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Add patch to distinguish between omitempty and default value.

Index

• Constants
• func IsPrimitiveType(t string) bool
• type Definitions
• type GoJSONSchemaExtension
• type Loader
  • func (l *Loader) Load(fromURL string) (io.ReadCloser, error)
• type ObjectAsType
• type Schema
  • func FromJSONFile(fileName string) (*Schema, error)
  • func FromJSONReader(r io.Reader) (*Schema, error)
  • func (s *Schema) UnmarshalJSON(data []byte) error
• type Type
  • func (value *Type) UnmarshalJSON(raw []byte) error
• type TypeList
  • func (t *TypeList) UnmarshalJSON(b []byte) error

Constants

const (
	TypeNameString  = "string"
	TypeNameArray   = "array"
	TypeNameNumber  = "number"
	TypeNameInteger = "integer"
	TypeNameObject  = "object"
	TypeNameBoolean = "boolean"
	TypeNameNull    = "null"
)

Functions

func IsPrimitiveType

func IsPrimitiveType(t string) bool

Types

type Definitions

type Definitions map[string]*Type

Definitions hold schema definitions. http://json-schema.org/latest/json-schema-validation.html#rfc.section.5.26 RFC draft-wright-json-schema-validation-00, section 5.26.

type GoJSONSchemaExtension

type GoJSONSchemaExtension struct {
	Type       *string  `json:"type,omitempty"`
	Identifier *string  `json:"identifier,omitempty"`
	Imports    []string `json:"imports,omitempty"`
}

type Loader

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

func (*Loader) Load

func (l *Loader) Load(fromURL string) (io.ReadCloser, error)

type ObjectAsType

type ObjectAsType Type

type Schema

type Schema struct {
	*ObjectAsType
	ID          string      `json:"$id"` // RFC draft-wright-json-schema-01, section-9.2.
	LegacyID    string      `json:"id"`  // RFC draft-wright-json-schema-00, section 4.5.
	Definitions Definitions `json:"$defs,omitempty"`
}

Schema is the root schema.

func FromJSONFile

func FromJSONFile(fileName string) (*Schema, error)

func FromJSONReader

func FromJSONReader(r io.Reader) (*Schema, error)

func (*Schema) UnmarshalJSON

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

UnmarshalJSON implements json.Unmarshaler for Schema struct.

type Type

type Type struct {
	// RFC draft-wright-json-schema-00.
	Version *string `json:"$schema,omitempty"` // Section 6.1.
	Ref     *string `json:"$ref,omitempty"`    // Section 7.
	// RFC draft-wright-json-schema-validation-00, section 5.
	MultipleOf           *int             `json:"multipleOf,omitempty"`           // Section 5.1.
	Maximum              *float64         `json:"maximum,omitempty"`              // Section 5.2.
	ExclusiveMaximum     *bool            `json:"exclusiveMaximum,omitempty"`     // Section 5.3.
	Minimum              *float64         `json:"minimum,omitempty"`              // Section 5.4.
	ExclusiveMinimum     *bool            `json:"exclusiveMinimum,omitempty"`     // Section 5.5.
	MaxLength            *int             `json:"maxLength,omitempty"`            // Section 5.6.
	MinLength            *int             `json:"minLength,omitempty"`            // Section 5.7.
	Pattern              *string          `json:"pattern,omitempty"`              // Section 5.8.
	AdditionalItems      *Type            `json:"additionalItems,omitempty"`      // Section 5.9.
	Items                *Type            `json:"items,omitempty"`                // Section 5.9.
	MaxItems             *int             `json:"maxItems,omitempty"`             // Section 5.10.
	MinItems             *int             `json:"minItems,omitempty"`             // Section 5.11.
	UniqueItems          bool             `json:"uniqueItems,omitempty"`          // Section 5.12.
	MaxProperties        *int             `json:"maxProperties,omitempty"`        // Section 5.13.
	MinProperties        *int             `json:"minProperties,omitempty"`        // Section 5.14.
	Required             []string         `json:"required,omitempty"`             // Section 5.15.
	Properties           map[string]*Type `json:"properties,omitempty"`           // Section 5.16.
	PatternProperties    map[string]*Type `json:"patternProperties,omitempty"`    // Section 5.17.
	AdditionalProperties *Type            `json:"additionalProperties,omitempty"` // Section 5.18.
	Enum                 []interface{}    `json:"enum,omitempty"`                 // Section 5.20.
	Type                 TypeList         `json:"type,omitempty"`                 // Section 5.21.
	AllOf                []*Type          `json:"allOf,omitempty"`                // Section 5.22.
	AnyOf                []*Type          `json:"anyOf,omitempty"`                // Section 5.23.
	OneOf                []*Type          `json:"oneOf,omitempty"`                // Section 5.24.
	Not                  *Type            `json:"not,omitempty"`                  // Section 5.25.
	// RFC draft-wright-json-schema-validation-00, section 6, 7.
	Title       *string     `json:"title,omitempty"`       // Section 6.1.
	Description *string     `json:"description,omitempty"` // Section 6.1.
	Default     interface{} `json:"default,omitempty"`     // Section 6.2.
	Format      *string     `json:"format,omitempty"`      // Section 7.
	// RFC draft-wright-json-schema-hyperschema-00, section 4.
	Media          *Type  `json:"media,omitempty"`          // Section 4.3.
	BinaryEncoding string `json:"binaryEncoding,omitempty"` // Section 4.3.
	// RFC draft-handrews-json-schema-validation-02, section 6.
	DependentRequired map[string][]string `json:"dependentRequired,omitempty"` // Section 6.5.4.
	// RFC draft-handrews-json-schema-validation-02, appendix A.
	Definitions      Definitions      `json:"$defs,omitempty"`
	DependentSchemas map[string]*Type `json:"dependentSchemas,omitempty"`

	// ExtGoCustomType is the name of a (qualified or not) custom Go type
	// to use for the field.
	GoJSONSchemaExtension *GoJSONSchemaExtension `json:"goJSONSchema,omitempty"` //nolint:tagliatelle // breaking change
}

Type represents a JSON Schema object type.

func (*Type) UnmarshalJSON

func (value *Type) UnmarshalJSON(raw []byte) error

UnmarshalJSON accepts booleans as schemas where `true` is equivalent to `{}` and `false` is equivalent to `{"not": {}}`.

type TypeList

type TypeList []string

TypeList is a list of type names.

func (*TypeList) UnmarshalJSON

func (t *TypeList) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler.