jsonschema

type AnchorString string

type AnyType struct {
	Core
	Metadata
}

type ArrayType struct {
	Type  string `json:"type,omitzero"`
	Items Schema `json:"items,omitzero"`

	// validate
	MaxItems    *uint64 `json:"maxItems,omitzero"`
	MinItems    *uint64 `json:"minItems,omitzero"`
	UniqueItems *bool   `json:"uniqueItems,omitzero"`

	Core
	Metadata
}

type BooleanType struct {
	Type string `json:"type,omitzero"`

	Core
	Metadata
}

type CanSwaggerDoc interface {
	SwaggerDoc() map[string]string
}

type Core struct {

	// default https://json-schema.org/draft/2020-12/schema
	Schema *URIString `json:"$schema,omitzero"`

	ID *URIReferenceString `json:"$id,omitzero"`

	Comment string `json:"$comment,omitzero"`

	Vocabulary map[URIString]bool `json:"$vocabulary,omitzero"`

	// https://json-schema.org/understanding-json-schema/structuring#anchor
	Anchor string `json:"$anchor,omitzero"`

	// for generics type
	// https://json-schema.org/blog/posts/dynamicref-and-generics
	DynamicAnchor string `json:"$dynamicAnchor,omitzero"`

	Defs map[string]Schema `json:"$defs,omitzero"`
}

type Discriminator struct {
	PropertyName string            `json:"propertyName"`
	Mapping      map[string]Schema `json:"mapping,omitzero"`
}

type EnumType struct {
	Enum []any `json:"enum"`

	Core
	Metadata
}

type Ext struct {
	Extensions map[string]any `json:",inline"`
}

type GoEnumValues interface {
	EnumValues() []any
}

type GoTaggedUnionType = validatortaggedunion.Type

type GoUnionType interface {
	OneOf() []any
}

type IntersectionType struct {
	AllOf []Schema `json:"allOf"`

	Core
	Metadata
}

type Metadata struct {
	Title       string `json:"title,omitzero"`
	Description string `json:"description,omitzero"`
	Default     any    `json:"default,omitzero"`
	WriteOnly   *bool  `json:"writeOnly,omitzero"`
	ReadOnly    *bool  `json:"readOnly,omitzero"`
	Examples    []any  `json:"examples,omitzero"`
	Deprecated  *bool  `json:"deprecated,omitzero"`

	Ext
}

type NullType struct {
	Type string `json:"type,omitzero"`

	Core
	Metadata
}

type NumberType struct {
	Type string `json:"type,omitzero"`

	// validate
	MultipleOf       *float64 `json:"multipleOf,omitzero"`
	Maximum          *float64 `json:"maximum,omitzero"`
	ExclusiveMaximum *float64 `json:"exclusiveMaximum,omitzero"`
	Minimum          *float64 `json:"minimum,omitzero"`
	ExclusiveMinimum *float64 `json:"exclusiveMinimum,omitzero"`

	Core
	Metadata
}

type ObjectType struct {
	Type string `json:"type,omitzero"`

	Properties           Props  `json:"properties,omitzero"`
	PropertyNames        Schema `json:"propertyNames,omitzero"`
	AdditionalProperties Schema `json:"additionalProperties,omitzero"`

	// validate
	Required      []string `json:"required,omitzero"`
	MaxProperties *uint64  `json:"maxProperties,omitzero"`
	MinProperties *uint64  `json:"minProperties,omitzero"`

	Core
	Metadata
}

type OpenAPISchemaFormatGetter interface {
	OpenAPISchemaFormat() string
}

type OpenAPISchemaGetter interface {
	OpenAPISchema() Schema
}

type OpenAPISchemaTypeGetter interface {
	OpenAPISchemaType() []string
}

type Payload struct {
	Schema
}

type Printer interface {
	io.Writer

	PrintFrom(pt PrinterTo, optionFns ...SchemaPrintOption)
	Print(values ...any)
	Printf(fmt string, values ...any)

	Indent() func()
	Return()
	PrintDoc(desc string)
}

type PrinterTo interface {
	PrintTo(w io.Writer, optionFns ...SchemaPrintOption)
}

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

type RefType struct {
	Ref        *URIReferenceString `json:"$ref,omitzero"`
	DynamicRef *URIReferenceString `json:"$dynamicRef,omitzero"`

	Core
	Metadata
}

type Refer interface {
	RefName() string
}

type Schema interface {
	GetCore() *Core
	GetMetadata() *Metadata
	PrintTo(w io.Writer, optionFns ...SchemaPrintOption)
}

type SchemaPrintOption func(o *printOption)

type StringType struct {
	Type   string `json:"type,omitzero"`
	Format string `json:"format,omitzero"`

	// validate
	MaxLength *uint64 `json:"maxLength,omitzero"`
	MinLength *uint64 `json:"minLength,omitzero"`
	Pattern   string  `json:"pattern,omitzero"`

	Core
	Metadata
}

type URIReferenceString url.URL

type URIString url.URL

type UnionType struct {
	OneOf         []Schema       `json:"oneOf"`
	Discriminator *Discriminator `json:"discriminator,omitzero"`

	Core
	Metadata
}