explain

Documentation

Index

• func NewCmdExplain(parent string, f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
• type ExplainOptions
  • func NewExplainOptions(parent string, streams genericclioptions.IOStreams) *ExplainOptions
  • func (o *ExplainOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error
  • func (o *ExplainOptions) Run() error
  • func (o *ExplainOptions) Validate() error

Functions

func NewCmdExplain

func NewCmdExplain(parent string, f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

NewCmdExplain returns a cobra command for swagger docs

Types

type ExplainOptions

type ExplainOptions struct {
	genericclioptions.IOStreams

	CmdParent  string
	APIVersion string
	Recursive  bool

	Mapper meta.RESTMapper
	Schema openapi.Resources

	// Toggles whether the OpenAPI v3 template-based renderer should be used to show
	// output.
	EnableOpenAPIV3 bool

	// Name of the template to use with the openapiv3 template renderer. If
	// `EnableOpenAPIV3` is disabled, this does nothing
	OutputFormat string

	// Client capable of fetching openapi documents from the user's cluster
	DiscoveryClient discovery.DiscoveryInterface
	// contains filtered or unexported fields
}

func NewExplainOptions

func NewExplainOptions(parent string, streams genericclioptions.IOStreams) *ExplainOptions

func (*ExplainOptions) Complete

func (o *ExplainOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error

func (*ExplainOptions) Run

func (o *ExplainOptions) Run() error

Run executes the appropriate steps to print a model's documentation

func (*ExplainOptions) Validate

func (o *ExplainOptions) Validate() error