examples

Documentation

Index

• type AllExamples
  • func Generate() AllExamples
• type ExamplesOrDeprecated
  • func (e *ExamplesOrDeprecated) Add(error status.Error)

Types

type AllExamples

type AllExamples map[string]ExamplesOrDeprecated

AllExamples is a map from error codes to either example errors, or a mark that the code is deprecated.

func Generate

func Generate() AllExamples

Generate generates example errors for documentation. KNV1XXX means the user has a mistake in their repository they need to fix. KNV2XXX means something went wrong in the cluster - it could be transient or users may need to change something on the cluster. KNV9XXX means we made a mistake programming, and users should file a bug.

type ExamplesOrDeprecated

type ExamplesOrDeprecated struct {
	Examples   []status.Error
	Deprecated bool
}

ExamplesOrDeprecated contains either a list of example errors, or that the id is deprecated.

func (*ExamplesOrDeprecated) Add

func (e *ExamplesOrDeprecated) Add(error status.Error)

Add adds the given error to the collection examples of errors.