extractors

package

v0.0.0-...-58f8293 Latest Latest Go to latest Published: Apr 27, 2024 License: MIT Imports: 16 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

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 EachStructField(t reflect.Type, each func(f *StructField))

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

func PatchSchemaValidationByValidateBytes(s jsonschema.Schema, typ reflect.Type, validateBytes []byte) (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)

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 StructField struct {
	reflect.StructField

	DisplayName string
	Optional    bool
}

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

func (sf *StructField) ToPropSchema(ctx context.Context, opt Opt) jsonschema.Schema

type TypeName string

func (t TypeName) RefString() string

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