templates

Documentation

Index

• Variables
• func Load(generatorFuncs map[string]interface{}, dir fs.FS, files ...string) (*template.Template, error)
• type TemplateData
  • func NewTemplateData(spec *openapi3spec.OpenAPI3, params map[string]string) *TemplateData
  • func NewTemplateDataWithObject(spec *openapi3spec.OpenAPI3, params map[string]string, name string, ...) *TemplateData
  • func (t TemplateData) Import(importName string) string

Variables

var GlobalFunctions = map[string]interface{}{
	"refName":                refName,
	"mustValidate":           mustValidate,
	"mustValidateRecurse":    mustValidateRecurse,
	"keysReflect":            keysReflect,
	"httpStatus":             http.StatusText,
	"newData":                newData,
	"newDataRequired":        newDataRequired,
	"recurseData":            recurseData,
	"recurseDataSetRequired": recurseDataSetRequired,
}

GlobalFunctions for templates

Functions

func Load

func Load(generatorFuncs map[string]interface{}, dir fs.FS, files ...string) (*template.Template, error)

Load takes in funcs to apply to each template, a directory that contains the files, and the file paths relative that directory

Types

type TemplateData

type TemplateData struct {
	Spec   *openapi3spec.OpenAPI3
	Params map[string]string

	Imports map[string]struct{}

	Name     string
	Object   interface{}
	Required bool
}

TemplateData for all generators

func NewTemplateData

func NewTemplateData(spec *openapi3spec.OpenAPI3, params map[string]string) *TemplateData

NewTemplateData constructor

func NewTemplateDataWithObject

func NewTemplateDataWithObject(spec *openapi3spec.OpenAPI3, params map[string]string, name string, object interface{}, required bool) *TemplateData

NewTemplateDataWithObject constructor

func (TemplateData) Import

func (t TemplateData) Import(importName string) string

Import records the importing of a library