Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

jsonschema

package module

Go to main page

Versions in this module

v1

v1.1.0

Dec 4, 2023

v1.0.1

Mar 1, 2021

v1.0.0

Jan 13, 2020

Changes in this version

+ type Type struct

+ AdditionalItems *Type

+ AdditionalProperties json.RawMessage

+ AllOf []*Type

+ AnyOf []*Type

+ BinaryEncoding string

+ Default interface{}

+ Definitions Definitions

+ Dependencies map[string]*Type

+ Description string

+ Enum []interface{}

+ ExclusiveMaximum bool

+ ExclusiveMinimum bool

+ Format string

+ Items *Type

+ MaxItems int

+ MaxLength int

+ MaxProperties int

+ Maximum int

+ Media *Type

+ MinItems int

+ MinLength int

+ MinProperties int

+ Minimum int

+ MultipleOf int

+ Not *Type

+ OneOf []*Type

+ Pattern string

+ PatternProperties map[string]*Type

+ Properties map[string]*Type

+ Ref string

+ Required []string

+ Title string

+ Type string

+ UniqueItems bool

+ Version string

v0

v0.12.0

Dec 4, 2023

Changes in this version

+ var FalseSchema = &Schema

+ var TrueSchema = &Schema

+ var Version = "https://json-schema.org/draft/2020-12/schema"

+ func ExtractGoComments(base, path string, commentMap map[string]string) error

+ func NewProperties() *orderedmap.OrderedMap[string, *Schema]

+ func ToSnakeCase(str string) string

+ type Definitions map[string]*Schema

+ type ID string

+ const EmptyID

+ func (id ID) Add(path string) ID

+ func (id ID) Anchor(name string) ID

+ func (id ID) Base() ID

+ func (id ID) Def(name string) ID

+ func (id ID) String() string

+ func (id ID) Validate() error

+ type Reflector struct

+ AdditionalFields func(reflect.Type) []reflect.StructField

+ AllowAdditionalProperties bool

+ Anonymous bool

+ AssignAnchor bool

+ BaseSchemaID ID

+ CommentMap map[string]string

+ DoNotReference bool

+ ExpandedStruct bool

+ FieldNameReflector func(f reflect.StructField) (string, bool)

+ FieldNameTag string

+ FieldReflector func(f reflect.StructField, s *Schema)

+ IgnoredTypes []any

+ KeyNamer func(string) string

+ Lookup func(reflect.Type) ID

+ Mapper func(reflect.Type) *Schema

+ Namer func(reflect.Type) string

+ RequiredFromJSONSchemaTags bool

+ func (r *Reflector) AddGoComments(base, path string) error

+ func (r *Reflector) Reflect(v any) *Schema

+ func (r *Reflector) ReflectFromType(t reflect.Type) *Schema

+ func (r *Reflector) SetBaseSchemaID(id string)

+ type Schema struct

+ AdditionalProperties *Schema

+ AllOf []*Schema

+ Anchor string

+ AnyOf []*Schema

+ Comments string

+ Const any

+ Contains *Schema

+ ContentEncoding string

+ ContentMediaType string

+ ContentSchema *Schema

+ Default any

+ Definitions Definitions

+ DependentRequired map[string][]string

+ DependentSchemas map[string]*Schema

+ Deprecated bool

+ Description string

+ DynamicRef string

+ Else *Schema

+ Enum []any

+ Examples []any

+ ExclusiveMaximum json.Number

+ ExclusiveMinimum json.Number

+ Extras map[string]any

+ Format string

+ ID ID

+ If *Schema

+ Items *Schema

+ MaxContains *uint64

+ MaxItems *uint64

+ MaxLength *uint64

+ MaxProperties *uint64

+ Maximum json.Number

+ MinContains *uint64

+ MinItems *uint64

+ MinLength *uint64

+ MinProperties *uint64

+ Minimum json.Number

+ MultipleOf json.Number

+ Not *Schema

+ OneOf []*Schema

+ Pattern string

+ PatternProperties map[string]*Schema

+ PrefixItems []*Schema

+ Properties *orderedmap.OrderedMap[string, *Schema]

+ PropertyNames *Schema

+ ReadOnly bool

+ Ref string

+ Required []string

+ Then *Schema

+ Title string

+ Type string

+ UniqueItems bool

+ Version string

+ WriteOnly bool

+ func Reflect(v any) *Schema

+ func ReflectFromType(t reflect.Type) *Schema

+ func (t *Schema) MarshalJSON() ([]byte, error)

+ func (t *Schema) UnmarshalJSON(data []byte) error