openapi

Documentation

Index

• Constants
• Variables
• func NewGenerator(opts Options) generation.MultiGroupGenerator
• type Options

Constants

const (
	// DefaultOutputFileBaseName is the default output file base name for the generated openapi functions.
	DefaultOutputFileBaseName = "zz_generated.openapi"
)

Variables

var (
	// DefaultOutputPackagePath is the default output package path for the generated openapi functions.
	DefaultOutputPackagePath = filepath.Join("openapi", "generated_openapi")
)

Functions

func NewGenerator

func NewGenerator(opts Options) generation.MultiGroupGenerator

NewGenerator builds a new openapi generator.

Types

type Options

type Options struct {
	// HeaderFilePath is the path to the file containing the boilerplate header text.
	// When omitted, no header is added to the generated files.
	HeaderFilePath string

	// OutputFileBaseName is the base name of the output file.
	// When omitted, DefaultOutputFileBaseName is used.
	// The current value of DefaultOutputFileBaseName is "zz_generated.openapi".
	OutputFileBaseName string

	// OutputPackagePath is the package path where the generated golang files will be written.
	OutputPackagePath string

	// Verify determines whether the generator should verify the content instead
	// of updating the generated file.
	Verify bool
}

Options contains the configuration required for the compatibility generator.