openapi

Documentation

Index

• Constants
• func DeReference(f *ast.File, rt *Runtime) func(path string) (*apiextv1.JSONSchemaProps, error)
• func FlattenSchema(src apiextv1.JSONSchemaProps) apiextv1.JSONSchemaProps
• func FromCueAST(rt *Runtime, cueSchema []ast.Decl) (*apiextv1.JSONSchemaProps, error)
• func GenerateOpenAPISchema(cueTpl string, schemaType string) (*apiextv1.JSONSchemaProps, error)
• func GetFieldByLabel(n ast.Node, label string) (*ast.Field, error)
• func IsFieldWithLabel(n ast.Node, label string) bool
• type Runtime
  • func NewRuntime(cueString string) (*Runtime, error)
  • func (r *Runtime) BuildFile(file *ast.File, options ...cue.BuildOption) cue.Value
  • func (r *Runtime) Context() *cue.Context
  • func (r *Runtime) Underlying() cue.Value

Constants

const (
	SchemaFieldName    = "schemas"
	ComponentFieldName = "components"
	DefaultSchemaName  = "spec"
	SchemaStructType   = "object"
)

Functions

func DeReference

func DeReference(f *ast.File, rt *Runtime) func(path string) (*apiextv1.JSONSchemaProps, error)

func FlattenSchema

func FlattenSchema(src apiextv1.JSONSchemaProps) apiextv1.JSONSchemaProps

FlattenSchema flattens the given schema to a single level.

func FromCueAST

func FromCueAST(rt *Runtime, cueSchema []ast.Decl) (*apiextv1.JSONSchemaProps, error)

func GenerateOpenAPISchema

func GenerateOpenAPISchema(cueTpl string, schemaType string) (*apiextv1.JSONSchemaProps, error)

GenerateOpenAPISchema generates openapi schema from cue type Definitions.

func GetFieldByLabel

func GetFieldByLabel(n ast.Node, label string) (*ast.Field, error)

func IsFieldWithLabel

func IsFieldWithLabel(n ast.Node, label string) bool

Types

type Runtime

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

func NewRuntime

func NewRuntime(cueString string) (*Runtime, error)

func (*Runtime) BuildFile

func (r *Runtime) BuildFile(file *ast.File, options ...cue.BuildOption) cue.Value

func (*Runtime) Context

func (r *Runtime) Context() *cue.Context

func (*Runtime) Underlying

func (r *Runtime) Underlying() cue.Value