Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetTypeName

func GetTypeName(schema proto.Schema) string

    GetTypeName returns the type of a schema.

    func LookupSchemaForField

    func LookupSchemaForField(schema proto.Schema, path []string) (proto.Schema, error)

      LookupSchemaForField looks for the schema of a given path in a base schema.

      func PrintModel

      func PrintModel(name string, writer *Formatter, builder fieldsPrinterBuilder, schema proto.Schema, gvk schema.GroupVersionKind) error

        PrintModel prints the description of a schema in writer.

        func PrintModelDescription

        func PrintModelDescription(fieldsPath []string, w io.Writer, schema proto.Schema, gvk schema.GroupVersionKind, recursive bool) error

          PrintModelDescription prints the description of a specific model or dot path. If recursive, all components nested within the fields of the schema will be printed.

          func SplitAndParseResourceRequest

          func SplitAndParseResourceRequest(inResource string, mapper meta.RESTMapper) (string, []string, error)

            SplitAndParseResourceRequest separates the users input into a model and fields

            Types

            type Formatter

            type Formatter struct {
            	IndentLevel int
            	Wrap        int
            	Writer      io.Writer
            }

              Formatter helps you write with indentation, and can wrap text as needed.

              func (Formatter) Indent

              func (f Formatter) Indent(indent int) *Formatter

                Indent creates a new Formatter that will indent the code by that much more.

                func (*Formatter) Write

                func (f *Formatter) Write(str string, a ...interface{}) error

                  Write writes a string with the indentation set for the Formatter. This is not wrapping text.

                  func (*Formatter) WriteWrapped

                  func (f *Formatter) WriteWrapped(str string, a ...interface{}) error

                    WriteWrapped writes a string with the indentation set for the Formatter, and wraps as needed.