definition

Documentation

Index

• Constants
• func GetFieldTag(field *ast.Field) reflect.StructTag
• type CommentInformation
• type Definition
• type Generator
  • func (dg *Generator) CollectDefinitionsFromStruct(thisPkg, rootStruct string)
• type GroupVersionKind
• type Meta
• type RefNameFormatFunc
• type TypeParamDefAndValue
  • func (p *TypeParamDefAndValue) Subst(pkg string, in ast.Expr) (string, ast.Expr)
  • func (p *TypeParamDefAndValue) Validate() error

Constants

const (
	// DefPrefix is the JSON Schema prefix required in the definition map
	DefPrefix = "#/definitions/"
)

Functions

func GetFieldTag

func GetFieldTag(field *ast.Field) reflect.StructTag

GetFieldTag gets the StructTag for a field

Types

type CommentInformation

type CommentInformation struct {
	SynthesizedComment string
	RemainingComment   string
}

CommentInformation holds information interpreted from a comment string

type Definition

type Definition struct {
	Ref                  string                 `json:"$ref,omitempty"`
	Items                *Definition            `json:"items,omitempty"`
	Required             []string               `json:"required,omitempty"`
	Properties           map[string]*Definition `json:"properties,omitempty"`
	PreferredOrder       []string               `json:"preferredOrder,omitempty"`
	AdditionalProperties interface{}            `json:"additionalProperties,omitempty"`
	Type                 string                 `json:"type,omitempty"`
	ContentEncoding      string                 `json:"contentEncoding,omitempty"`
	OneOf                []*Definition          `json:"oneOf,omitempty"`
	Description          string                 `json:"description,omitempty"`
	HTMLDescription      string                 `json:"x-intellij-html-description,omitempty"`
	KubernetesGvk        []*GroupVersionKind    `json:"x-kubernetes-group-version-kind,omitempty"`
	Default              interface{}            `json:"default,omitempty"`
	Examples             []string               `json:"examples,omitempty"`
	Enum                 []string               `json:"enum,omitempty"`

	PatternProperties map[string]*Definition `json:"patternProperties,omitempty"`
}

Definition represents a JSON Schema definition

type Generator

type Generator struct {
	Strict      bool
	Definitions map[string]*Definition
	Importer    importer.Importer

	// TagNamespace to select which tag to use (e.g. json, yaml)
	TagNamespace string

	// FromatRefName allows customization of the ref name
	FromatRefName RefNameFormatFunc
}

Generator can create definitions from Exprs

func (*Generator) CollectDefinitionsFromStruct

func (dg *Generator) CollectDefinitionsFromStruct(thisPkg, rootStruct string)

CollectDefinitionsFromStruct gets a complete definition for the root object

type GroupVersionKind

type GroupVersionKind struct {
	Group   string `json:"group"`
	Version string `json:"version"`
	Kind    string `json:"kind"`
}

type Meta

type Meta struct {
	Required bool
	NoDerive bool
}

type RefNameFormatFunc

type RefNameFormatFunc func(pkg, name string) string

type TypeParamDefAndValue

type TypeParamDefAndValue struct {
	Defs         *ast.FieldList // Defs can be nil until we discovered type definition
	TypePackages []string
	Types        []ast.Expr // Values are concrete types
}

func (*TypeParamDefAndValue) Subst

func (p *TypeParamDefAndValue) Subst(pkg string, in ast.Expr) (string, ast.Expr)

func (*TypeParamDefAndValue) Validate

func (p *TypeParamDefAndValue) Validate() error