Documentation
¶
Index ¶
- func GenerateDoc(formPath string, w io.Writer) error
- func NewCommands() *cobra.Command
- func NewGenDocCmd() *cobra.Command
- func NewGetCommand() *cobra.Command
- func NewListCommand() *cobra.Command
- func NewValidateFormCmd() *cobra.Command
- func WithFlagForms(cmd *cobra.Command) string
- type Parameter
- type Section
- type Technology
- type Usecase
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GenerateDoc ¶ added in v1.0.58
GenerateDoc is the method used to generate documentation from a stackform
func NewCommands ¶
func NewGenDocCmd ¶ added in v1.0.58
NewGendDocCmd returns the cobra command holding the forms gen-doc subcommand
func NewGetCommand ¶
func NewListCommand ¶
func NewValidateFormCmd ¶ added in v1.0.58
func WithFlagForms ¶ added in v1.0.58
Types ¶
type Parameter ¶ added in v1.0.58
type Parameter struct {
// Key of the parameter
Key string
// Type of the parameter
Type string
// Default value, currently supported: string / integer
Default interface{}
// Description is the parameter description
Description string
}
Parameter is the parameter described in the the section (e.g: required: true, type: string, etc.)
type Section ¶ added in v1.0.58
type Section struct {
// Name is the name of the section
Name string
// Parameters holds the list
// of the parameter in the section
Parameters []Parameter
}
Section is the section described in the technology (e.g: ec2, network, etc.)
type Technology ¶ added in v1.0.58
type Technology struct {
// Name is the name of the technology
Name string
// Sections holds the list
// of sections in the technologoy
Sections []Section
}
Technology is the technology described in the stack forms (e.g: terraform, pipeline, etc.)
type Usecase ¶ added in v1.0.58
type Usecase struct {
// Name is the name of the usecase
Name string
// Technologies holds the list
// of technologies in the stackforms
Technologies []Technology
}
Usecase of the forms, default is `default` one
Click to show internal directories.
Click to hide internal directories.