jsonschema

Feb 24, 2024

Changes in this version

+ type EmbedReferencer interface

+ ReferEmbedded func()

Sep 29, 2023

Changes in this version

type InterceptPropParams

+ ParentSchema *Schema

Sep 21, 2023

Changes in this version

type Schema

+ func (s *Schema) RemoveType(t SimpleType)

Aug 8, 2023

Changes in this version

+ type Field struct

+ Name string

+ Tag reflect.StructTag

+ Value interface{}

+ type Struct struct

+ DefName string

+ Description *string

+ Fields []Field

+ Nullable bool

+ Title *string

+ func (s *Struct) SetDescription(description string)

+ func (s *Struct) SetTitle(title string)

Jul 30, 2023

Changes in this version

+ func InterceptDefName(f func(t reflect.Type, defaultDefName string) string) func(reflectContext *ReflectContext)

Apr 25, 2023

Changes in this version

type InterceptNullabilityParams

+ Context *ReflectContext

type InterceptPropParams

+ Context *ReflectContext

type InterceptSchemaParams

+ Context *ReflectContext

Apr 24, 2023

Changes in this version

+ func InterceptProp(f InterceptPropFunc) func(reflectContext *ReflectContext)

+ func InterceptSchema(f InterceptSchemaFunc) func(*ReflectContext)

+ type InterceptPropFunc func(params InterceptPropParams) error

+ type InterceptPropParams struct

+ Field reflect.StructField

+ Name string

+ Path []string

+ Processed bool

+ PropertySchema *Schema

+ type InterceptSchemaFunc func(params InterceptSchemaParams) (stop bool, err error)

+ type InterceptSchemaParams struct

+ Processed bool

+ Schema *Schema

+ Value reflect.Value

Jan 18, 2023

Changes in this version

type ReflectContext

+ PropertyNameAdditionalTags []string

Nov 21, 2022

Changes in this version

+ func InterceptNullability(f InterceptNullabilityFunc) func(reflectContext *ReflectContext)

+ type InterceptNullabilityFunc func(params InterceptNullabilityParams)

+ type InterceptNullabilityParams struct

+ NullAdded bool

+ OmitEmpty bool

+ OrigSchema Schema

+ RefDef *Schema

+ Schema *Schema

+ Type reflect.Type

type ReflectContext

+ InterceptNullability InterceptNullabilityFunc

Nov 11, 2022

Changes in this version

type Reflector

+ func (r *Reflector) InlineDefinition(sample interface{})

type SchemaOrBool

+ func (s *SchemaOrBool) FromSimpleMap(m map[string]interface{}) error

Sep 22, 2022

Changes in this version

+ func SkipUnsupportedProperties(rc *ReflectContext)

type ReflectContext

+ SkipUnsupportedProperties bool

May 8, 2022

Changes in this version

type ReflectContext

+ SkipNonConstraints bool

Apr 19, 2022

Changes in this version

type AllOfExposer

+ func AllOf(v ...interface{}) AllOfExposer

type AnyOfExposer

+ func AnyOf(v ...interface{}) AnyOfExposer

type OneOfExposer

+ func OneOf(v ...interface{}) OneOfExposer

+ type SchemaInliner interface

+ InlineJSONSchema func()

Apr 14, 2022

Changes in this version

type ReflectContext

+ UnnamedFieldWithTag bool

Mar 28, 2022

Changes in this version

+ func ProcessWithoutTags(process bool) func(rc *ReflectContext)

type ReflectContext

+ ProcessWithoutTags bool

type Schema

+ Parent *Schema

Mar 20, 2022

Changes in this version

+ const ErrSkipProperty

+ func StripDefinitionNamePrefix(prefix ...string) func(rc *ReflectContext)

+ type AllOfExposer interface

+ JSONSchemaAllOf func() []interface{}

+ type AnyOfExposer interface

+ JSONSchemaAnyOf func() []interface{}

+ type ElseExposer interface

+ JSONSchemaElse func() interface{}

+ type IfExposer interface

+ JSONSchemaIf func() interface{}

+ type NotExposer interface

+ JSONSchemaNot func() interface{}

+ type OneOfExposer interface

+ JSONSchemaOneOf func() []interface{}

+ type ThenExposer interface

+ JSONSchemaThen func() interface{}

Jul 23, 2021

Changes in this version

type ReflectContext

+ DefName func(t reflect.Type, defaultDefName string) string

type Reflector

+ func (r *Reflector) InterceptDefName(f func(t reflect.Type, defaultDefName string) string)

Feb 7, 2021

Changes in this version

+ const DateLayout

+ type Date time.Time

+ func (d *Date) UnmarshalJSON(data []byte) error

+ func (d *Date) UnmarshalText(data []byte) error

+ func (d Date) MarshalJSON() ([]byte, error)

+ func (d Date) MarshalText() ([]byte, error)

Nov 12, 2020

Changes in this version

type Schema

+ ReflectType reflect.Type

Oct 12, 2020

Changes in this version

type Schema

+ func (s Schema) IsTrivial() bool

type SchemaOrBool

+ func (s SchemaOrBool) IsTrivial() bool

Oct 3, 2020

Changes in this version

+ func MakePropertyNameMapping(v interface{}, tagName string) map[string]string

+ func PropertyNameMapping(mapping map[string]string) func(rc *ReflectContext)

type ReflectContext

+ PropertyNameMapping map[string]string

Aug 25, 2020

Changes in this version

+ func SkipEmbeddedMapsSlices(rc *ReflectContext)

type ReflectContext

+ SkipEmbeddedMapsSlices bool

Jun 19, 2020

Changes in this version

type ReflectContext

+ EnvelopNullability bool

Jun 13, 2020

Changes in this version

type Schema

+ func (s *Schema) HasType(t SimpleType) bool

type SimpleType

+ func (i SimpleType) ToSchemaOrBool() SchemaOrBool

May 27, 2020

Changes in this version

+ type IgnoreTypeName interface

+ IgnoreTypeName func()

type Schema

+ func (s Schema) IgnoreTypeName()

Apr 24, 2020

Changes in this version

+ func RootNullable(rc *ReflectContext)

type ReflectContext

+ RootNullable bool

Apr 23, 2020

Changes in this version

+ func CollectDefinitions(schemas map[string]Schema) func(*ReflectContext)

type ReflectContext

+ CollectDefinitions map[string]Schema

Apr 11, 2020

Changes in this version

+ type RawExposer interface

+ JSONSchemaBytes func() ([]byte, error)

type Schema

+ func (s Schema) JSONSchemaBytes() ([]byte, error)

type SchemaOrBool

+ func (s SchemaOrBool) JSONSchemaBytes() ([]byte, error)

+ func (s SchemaOrBool) ToSimpleMap() (map[string]interface{}, error)

Apr 8, 2020

Changes in this version

type DependenciesAdditionalProperties

+ func (d *DependenciesAdditionalProperties) SchemaOrBoolEns() *SchemaOrBool

type Items

+ func (i *Items) SchemaOrBoolEns() *SchemaOrBool

type Schema

+ func (s *Schema) AdditionalItemsEns() *SchemaOrBool

+ func (s *Schema) AdditionalPropertiesEns() *SchemaOrBool

+ func (s *Schema) ContainsEns() *SchemaOrBool

+ func (s *Schema) ElseEns() *SchemaOrBool

+ func (s *Schema) IfEns() *SchemaOrBool

+ func (s *Schema) ItemsEns() *Items

+ func (s *Schema) NotEns() *SchemaOrBool

+ func (s *Schema) PropertyNamesEns() *SchemaOrBool

+ func (s *Schema) ThenEns() *SchemaOrBool

+ func (s *Schema) TypeEns() *Type

type SchemaOrBool

+ func (s *SchemaOrBool) TypeObjectEns() *Schema

Apr 2, 2020

Changes in this version

+ const Array

+ const Boolean

+ const Integer

+ const Null

+ const Number

+ const Object

+ const String

+ const XEnumNames

+ func DefinitionsPrefix(prefix string) func(*ReflectContext)

+ func InlineRefs(pc *ReflectContext)

+ func InterceptProperty(f InterceptPropertyFunc) func(*ReflectContext)

+ func InterceptType(f InterceptTypeFunc) func(*ReflectContext)

+ func PropertyNameTag(tag string) func(*ReflectContext)

+ func RootRef(pc *ReflectContext)

+ type DependenciesAdditionalProperties struct

+ SchemaOrBool *SchemaOrBool

+ StringArray []string

+ func (d *DependenciesAdditionalProperties) UnmarshalJSON(data []byte) error

+ func (d *DependenciesAdditionalProperties) WithSchemaOrBool(val SchemaOrBool) *DependenciesAdditionalProperties

+ func (d *DependenciesAdditionalProperties) WithStringArray(val ...string) *DependenciesAdditionalProperties

+ func (d DependenciesAdditionalProperties) MarshalJSON() ([]byte, error)

+ type Described interface

+ Description func() string

+ type Enum interface

+ Enum func() []interface{}

+ type Exposer interface

+ JSONSchema func() (Schema, error)

+ type InterceptPropertyFunc func(name string, field reflect.StructField, propertySchema *Schema) error

+ type InterceptTypeFunc func(reflect.Value, *Schema) (bool, error)

+ type Items struct

+ SchemaArray []SchemaOrBool

+ SchemaOrBool *SchemaOrBool

+ func (i *Items) UnmarshalJSON(data []byte) error

+ func (i *Items) WithSchemaArray(val ...SchemaOrBool) *Items

+ func (i *Items) WithSchemaOrBool(val SchemaOrBool) *Items

+ func (i Items) MarshalJSON() ([]byte, error)

+ type NamedEnum interface

+ NamedEnum func() ([]interface{}, []string)

+ type Preparer interface

+ PrepareJSONSchema func(schema *Schema) error

+ type Ref struct

+ Name string

+ Path string

+ func (r Ref) Schema() Schema

+ type ReflectContext struct

+ DefinitionsPrefix string

+ InlineRefs bool

+ InterceptProperty InterceptPropertyFunc

+ InterceptType InterceptTypeFunc

+ Path []string

+ PropertyNameTag string

+ RootRef bool

+ type Reflector struct

+ DefaultOptions []func(*ReflectContext)

+ func (r *Reflector) AddTypeMapping(src, dst interface{})

+ func (r *Reflector) Reflect(i interface{}, options ...func(*ReflectContext)) (Schema, error)

+ type Schema struct

+ AdditionalItems *SchemaOrBool

+ AdditionalProperties *SchemaOrBool

+ AllOf []SchemaOrBool

+ AnyOf []SchemaOrBool

+ Comment *string

+ Const *interface{}

+ Contains *SchemaOrBool

+ ContentEncoding *string

+ ContentMediaType *string

+ Default *interface{}

+ Definitions map[string]SchemaOrBool

+ Dependencies map[string]DependenciesAdditionalProperties

+ Description *string

+ Else *SchemaOrBool

+ Enum []interface{}

+ Examples []interface{}

+ ExclusiveMaximum *float64

+ ExclusiveMinimum *float64

+ ExtraProperties map[string]interface{}

+ Format *string

+ ID *string

+ If *SchemaOrBool

+ Items *Items

+ MaxItems *int64

+ MaxLength *int64

+ MaxProperties *int64

+ Maximum *float64

+ MinItems int64

+ MinLength int64

+ MinProperties int64

+ Minimum *float64

+ MultipleOf *float64

+ Not *SchemaOrBool

+ OneOf []SchemaOrBool

+ Pattern *string

+ PatternProperties map[string]SchemaOrBool

+ Properties map[string]SchemaOrBool

+ PropertyNames *SchemaOrBool

+ ReadOnly *bool

+ Ref *string

+ Required []string

+ Schema *string

+ Then *SchemaOrBool

+ Title *string

+ Type *Type

+ UniqueItems *bool

+ func (s *Schema) AddType(t SimpleType)

+ func (s *Schema) ToSchemaOrBool() SchemaOrBool

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

+ func (s *Schema) WithAdditionalItems(val SchemaOrBool) *Schema

+ func (s *Schema) WithAdditionalProperties(val SchemaOrBool) *Schema

+ func (s *Schema) WithAllOf(val ...SchemaOrBool) *Schema

+ func (s *Schema) WithAnyOf(val ...SchemaOrBool) *Schema

+ func (s *Schema) WithComment(val string) *Schema

+ func (s *Schema) WithConst(val interface{}) *Schema

+ func (s *Schema) WithContains(val SchemaOrBool) *Schema

+ func (s *Schema) WithContentEncoding(val string) *Schema

+ func (s *Schema) WithContentMediaType(val string) *Schema

+ func (s *Schema) WithDefault(val interface{}) *Schema

+ func (s *Schema) WithDefinitions(val map[string]SchemaOrBool) *Schema

+ func (s *Schema) WithDefinitionsItem(key string, val SchemaOrBool) *Schema

+ func (s *Schema) WithDependencies(val map[string]DependenciesAdditionalProperties) *Schema

+ func (s *Schema) WithDependenciesItem(key string, val DependenciesAdditionalProperties) *Schema

+ func (s *Schema) WithDescription(val string) *Schema

+ func (s *Schema) WithElse(val SchemaOrBool) *Schema

+ func (s *Schema) WithEnum(val ...interface{}) *Schema

+ func (s *Schema) WithExamples(val ...interface{}) *Schema

+ func (s *Schema) WithExclusiveMaximum(val float64) *Schema

+ func (s *Schema) WithExclusiveMinimum(val float64) *Schema

+ func (s *Schema) WithExtraProperties(val map[string]interface{}) *Schema

+ func (s *Schema) WithExtraPropertiesItem(key string, val interface{}) *Schema

+ func (s *Schema) WithFormat(val string) *Schema

+ func (s *Schema) WithID(val string) *Schema

+ func (s *Schema) WithIf(val SchemaOrBool) *Schema

+ func (s *Schema) WithItems(val Items) *Schema

+ func (s *Schema) WithMaxItems(val int64) *Schema

+ func (s *Schema) WithMaxLength(val int64) *Schema

+ func (s *Schema) WithMaxProperties(val int64) *Schema

+ func (s *Schema) WithMaximum(val float64) *Schema

+ func (s *Schema) WithMinItems(val int64) *Schema

+ func (s *Schema) WithMinLength(val int64) *Schema

+ func (s *Schema) WithMinProperties(val int64) *Schema

+ func (s *Schema) WithMinimum(val float64) *Schema

+ func (s *Schema) WithMultipleOf(val float64) *Schema

+ func (s *Schema) WithNot(val SchemaOrBool) *Schema

+ func (s *Schema) WithOneOf(val ...SchemaOrBool) *Schema

+ func (s *Schema) WithPattern(val string) *Schema

+ func (s *Schema) WithPatternProperties(val map[string]SchemaOrBool) *Schema

+ func (s *Schema) WithPatternPropertiesItem(key string, val SchemaOrBool) *Schema

+ func (s *Schema) WithProperties(val map[string]SchemaOrBool) *Schema

+ func (s *Schema) WithPropertiesItem(key string, val SchemaOrBool) *Schema

+ func (s *Schema) WithPropertyNames(val SchemaOrBool) *Schema

+ func (s *Schema) WithReadOnly(val bool) *Schema

+ func (s *Schema) WithRef(val string) *Schema

+ func (s *Schema) WithRequired(val ...string) *Schema

+ func (s *Schema) WithSchema(val string) *Schema

+ func (s *Schema) WithThen(val SchemaOrBool) *Schema

+ func (s *Schema) WithTitle(val string) *Schema

+ func (s *Schema) WithType(val Type) *Schema

+ func (s *Schema) WithUniqueItems(val bool) *Schema

+ func (s Schema) JSONSchema() (Schema, error)

+ func (s Schema) MarshalJSON() ([]byte, error)

+ type SchemaOrBool struct

+ TypeBoolean *bool

+ TypeObject *Schema

+ func (s *SchemaOrBool) UnmarshalJSON(data []byte) error

+ func (s *SchemaOrBool) WithTypeBoolean(val bool) *SchemaOrBool

+ func (s *SchemaOrBool) WithTypeObject(val Schema) *SchemaOrBool

+ func (s SchemaOrBool) MarshalJSON() ([]byte, error)

+ type SimpleType string

+ func (i *SimpleType) UnmarshalJSON(data []byte) error

+ func (i SimpleType) MarshalJSON() ([]byte, error)

+ func (i SimpleType) Type() Type

+ type Titled interface

+ Title func() string

+ type Type struct

+ SimpleTypes *SimpleType

+ SliceOfSimpleTypeValues []SimpleType

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

+ func (t *Type) WithSimpleTypes(val SimpleType) *Type

+ func (t *Type) WithSliceOfSimpleTypeValues(val ...SimpleType) *Type

+ func (t Type) MarshalJSON() ([]byte, error)