extractors

package

v0.0.0-...-95995d7 Latest Latest Go to latest Published: Dec 30, 2024 License: MIT Imports: 18 Imported by: 1

Details

Package extractors GENERATED BY gengo:runtimedoc DON'T EDIT THIS FILE

This section is empty.

View Source

var RuntimeDocerContext = contextx.New[RuntimeDocer]()

View Source

var SchemaRegisterContext = contextx.New[SchemaRegister](contextx.WithDefaultsFunc(func() SchemaRegister {
	return &defaultSchemaRegister{}
}))

func FieldShouldPick(t reflect.Type, fieldName string) bool

func PatchSchemaValidation(s jsonschema.Schema, opt validator.Option) (jsonschema.Schema, error)

func PatchSchemaValidationByValidator(s jsonschema.Schema, v validator.Validator) jsonschema.Schema

func RegisterFieldFilter(t reflect.Type, fieldFilter FieldFilter)

func SchemaFrom(ctx context.Context, v any, def bool) jsonschema.Schema

func SchemaFromType(ctx context.Context, t reflect.Type, opt Opt) (s jsonschema.Schema)

func SetTitleOrDescription(metadata *jsonschema.Metadata, lines []string)

type FieldExclude func(fields ...string)

func (FieldExclude) RuntimeDoc(names ...string) ([]string, bool)

type FieldFilter struct {
	Exclude []string
	Include []string
}

func (v FieldFilter) RuntimeDoc(names ...string) ([]string, bool)

type Opt struct {
	Decl      bool
	Doc       map[string]string
	EnumInDoc []string
}

func (v Opt) RuntimeDoc(names ...string) ([]string, bool)

func (o Opt) WithDecl(decl bool) Opt

func (o Opt) WithDoc(doc map[string]string) Opt

func (o Opt) WithEnumInDoc(enumInDoc []string) Opt

type RuntimeDocer interface {
	RuntimeDoc(names ...string) ([]string, bool)
}

type SchemaRegister interface {
	RegisterSchema(ref string, s jsonschema.Schema)
	RefString(ref string) string
	Record(typeRef string) bool
}

type TypeName string

func (t TypeName) RefString() string

func (TypeName) RuntimeDoc(names ...string) ([]string, bool)