openapi_generator

Documentation

Index

• func CheckBackwardCompatibility(existingCRDsPath, yamlsPath string, force bool) error
• type Generator
  • func NewGenerator(rawDefinitions map[string]common.OpenAPIDefinition) (*Generator, error)
  • func (g *Generator) AddDefinition(name string, rawDef common.OpenAPIDefinition) error
  • func (g *Generator) MissingDefinitions() map[string]struct{}
  • func (g *Generator) ResolveRefs() error
  • func (g *Generator) SetNamePrefix(namePrefix string)
  • func (g *Generator) UpdateYAMLs(yamlsPath string) error

Functions

func CheckBackwardCompatibility

func CheckBackwardCompatibility(existingCRDsPath, yamlsPath string, force bool) error

Types

type Generator

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

func NewGenerator

func NewGenerator(rawDefinitions map[string]common.OpenAPIDefinition) (*Generator, error)

NewGenerator returns a new Generator instance and an error. rawDefinitions is a value returned by GetOpenAPIDefinitions functions created by openapi-gen from k8s.io/kube-openapi.

func (*Generator) AddDefinition

func (g *Generator) AddDefinition(name string, rawDef common.OpenAPIDefinition) error

AddDefinition is a helper for adding default definitions. This should not be needed in day to day usage, useful for testing.

func (*Generator) MissingDefinitions

func (g *Generator) MissingDefinitions() map[string]struct{}

MissingDefinitions is a simple getter for g.missingDefinitions.

func (*Generator) ResolveRefs

func (g *Generator) ResolveRefs() error

ResolveRefs calls resolveRefsForPackage for each package which has not been resolved yet

func (*Generator) SetNamePrefix

func (g *Generator) SetNamePrefix(namePrefix string)

SetNamePrefix sets the namePrefix used in name creation. This should not be needed in day to day usage, useful for testing.

func (*Generator) UpdateYAMLs

func (g *Generator) UpdateYAMLs(yamlsPath string) error