config

Documentation

Index

• func LoadMonaxSpec() (*openapi3.Swagger, error)
• type Apply
• type Build
• type Describe
• type Get
• type Login
• type Nax
  • func GetDefaultNax() *Nax
• type Run

Functions

func LoadMonaxSpec

func LoadMonaxSpec() (*openapi3.Swagger, error)

LoadMonaxSpec takes the embedded OpenAPI spec for the Monax API and loads it into a structured object using the getkin openapi3 library

Types

type Apply

type Apply struct {
	Source io.Reader
}

Apply is the struct that provides the configuration object sent to the apply command

type Build

type Build struct {
	BuildDestination io.Writer
	Source           string
}

Build is the struct that provides the configuration object sent to the build command

type Describe

type Describe struct {
	Internal  bool
	Operation string
	Arguments []string
}

Describe is the struct that provides the configuration object sent to the describe command

type Get

type Get struct {
	Operation      string
	Arguments      []string
	OuputStructure string
}

Get is the struct that provides the configuration object sent to the get command

type Login

type Login struct {
	Password string
	User     string
}

Login is the struct that provides the configuration object sent to the login command

type Nax

type Nax struct {
	Destination string
	Arguments   []string
	UglyPrint   bool
	Verbose     bool
	Apply       *Apply
	Build       *Build
	Describe    *Describe
	Get         *Get
	Login       *Login
	Run         *Run
}

Nax is the primary configuration object that is leveraged by the nax runtime. It contains all of the available configuration objects.

func GetDefaultNax

func GetDefaultNax() *Nax

GetDefaultNax returns a Nax config object with the default paramemters suppled. This should be called only once within the main function of the runtime and populated with flags, env vars and config files only AFTER running this function which should be thought of as the 'new' func.ß

type Run

type Run struct {
	Operation  string
	Parameters map[string]string
}

Run is the struct that provides the configuration object sent to the run commands