Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewCmdExplain ¶
func NewCmdExplain(parent string, f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command
NewCmdExplain returns a cobra command for swagger docs
Types ¶
type ExplainFlags ¶ added in v0.33.0
type ExplainFlags struct {
APIVersion string
OutputFormat string
Recursive bool
genericiooptions.IOStreams
}
ExplainFlags directly reflect the information that CLI is gathering via flags. They will be converted to Options, which reflect the runtime requirements for the command.
func NewExplainFlags ¶ added in v0.33.0
func NewExplainFlags(streams genericiooptions.IOStreams) *ExplainFlags
NewExplainFlags returns a default ExplainFlags
func (*ExplainFlags) AddFlags ¶ added in v0.33.0
func (flags *ExplainFlags) AddFlags(cmd *cobra.Command)
AddFlags registers flags for a cli
func (*ExplainFlags) ToOptions ¶ added in v0.33.0
func (flags *ExplainFlags) ToOptions(f cmdutil.Factory, parent string, args []string) (*ExplainOptions, error)
ToOptions converts from CLI inputs to runtime input
type ExplainOptions ¶
type ExplainOptions struct {
genericiooptions.IOStreams
Recursive bool
APIVersion string
// Name of the template to use with the openapiv3 template renderer.
OutputFormat string
CmdParent string
Mapper meta.RESTMapper
// Client capable of fetching openapi documents from the user's cluster
OpenAPIV3Client openapiclient.Client
// contains filtered or unexported fields
}
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
Source Files
Click to show internal directories.
Click to hide internal directories.