extractors

package

v0.0.1 Latest Latest Go to latest Published: Jun 25, 2026 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/xoctopus/httpx

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func FieldShouldPick(t reflect.Type, fieldName string) bool
func PatchSchemaValidation(s jsonschema.Schema, opt validation.Option) (jsonschema.Schema, error)
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
type FieldFilter
type K8sAPIVersionGetter
type K8sKindGetter
type K8sObjectKindGetter
type Opt
type SchemaRegister
- func SchemaRegisterFrom(ctx context.Context) SchemaRegister
type TypeName
- func (t TypeName) RefString() string

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	WithSchemaRegister  = contextx.With[tCtxRegister, SchemaRegister]
	MustSchemaRegister  = contextx.Must[tCtxRegister, SchemaRegister]
	CarrySchemaRegister = contextx.Carry[tCtxRegister, SchemaRegister]
)

Functions ¶

func FieldShouldPick ¶

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

func PatchSchemaValidation ¶

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

func RegisterFieldFilter ¶

func RegisterFieldFilter(t reflect.Type, fieldFilter FieldFilter)

func SchemaFrom ¶

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

func SchemaFromType ¶

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

func SetTitleOrDescription ¶

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

Types ¶

type FieldExclude ¶

type FieldExclude func(fields ...string)

type FieldFilter ¶

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

type K8sAPIVersionGetter ¶

type K8sAPIVersionGetter interface {
	GetAPIVersion() string
}

type K8sKindGetter ¶

type K8sKindGetter interface {
	GetKind() string
}

type K8sObjectKindGetter ¶

type K8sObjectKindGetter interface {
	GetObjectKind() schema.ObjectKind
}

type Opt ¶

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

func (Opt) WithDecl ¶

func (o Opt) WithDecl(decl bool) Opt

func (Opt) WithDoc ¶

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

func (Opt) WithEnumInDoc ¶

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

type SchemaRegister ¶

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

func SchemaRegisterFrom ¶

func SchemaRegisterFrom(ctx context.Context) SchemaRegister

type TypeName ¶

type TypeName string

func (TypeName) RefString ¶

func (t TypeName) RefString() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL