resources

Documentation

Index

• func AddAllResourceCmds(rootCmd *cobra.Command, client resources.Client, ...)
• func NewOperationCmd(parentCmd *cobra.Command, client resources.Client, ...) *cobra.Command
• func NewResourceCmd(parentCmd *cobra.Command, analyticsTrackerFn analytics.TrackerFn, ...) *cobra.Command
• func NewResources(tags openapi3.Tags) map[string]ResourceData
• func NewResourcesCmd() *cobra.Command
• func SubcommandUsageTemplate() string
• type OperationCmd
• type OperationData
• type Param
• type ResourceData
  • func NewResourceData(tag openapi3.Tag) ResourceData
• type TemplateData
  • func GetTemplateData(fileName string) (TemplateData, error)

Functions

func AddAllResourceCmds

func AddAllResourceCmds(
	rootCmd *cobra.Command,
	client resources.Client,
	analyticsTrackerFn analytics.TrackerFn,
)

func NewOperationCmd

func NewOperationCmd(
	parentCmd *cobra.Command,
	client resources.Client,
	markdownRenderer *glamour.TermRenderer,
	op OperationData,
) *cobra.Command

func NewResourceCmd

func NewResourceCmd(
	parentCmd *cobra.Command,
	analyticsTrackerFn analytics.TrackerFn,
	markdownRenderer *glamour.TermRenderer,
	resourceName, longDescription string,
) *cobra.Command

func NewResources

func NewResources(tags openapi3.Tags) map[string]ResourceData

func NewResourcesCmd

func NewResourcesCmd() *cobra.Command

func SubcommandUsageTemplate

func SubcommandUsageTemplate() string

Types

type OperationCmd

type OperationCmd struct {
	OperationData
	// contains filtered or unexported fields
}

type OperationData

type OperationData struct {
	Short                 string
	Long                  string
	Use                   string
	Params                []Param
	HTTPMethod            string
	HasBody               bool
	IsBeta                bool
	RequiresBody          bool
	Path                  string
	SupportsSemanticPatch bool
}

type Param

type Param struct {
	Name        string
	In          string
	Description string
	Type        string
	Required    bool
}

type ResourceData

type ResourceData struct {
	GoName      string
	DisplayName string
	Description string
	Operations  map[string]OperationData
}

func NewResourceData

func NewResourceData(tag openapi3.Tag) ResourceData

type TemplateData

type TemplateData struct {
	Resources map[string]ResourceData
}

func GetTemplateData

func GetTemplateData(fileName string) (TemplateData, error)