Merge pull request #247 from meshery/nithish/feat/validation_types

[Refactor] Add `ErrorV2` struct

errors/errors.go

@@ -83,8 +83,24 @@ func New(code string, severity Severity, sdescription []string, ldescription []s
 	}
 }
 
+func NewV2(code string, severity Severity, sdescription []string, ldescription []string, probablecause []string, remedy []string, additionalInfo interface{}) *ErrorV2 {
+	return &ErrorV2{
+		Code:                 code,
+		Severity:             severity,
+		ShortDescription:     sdescription,
+		LongDescription:      ldescription,
+		ProbableCause:        probablecause,
+		SuggestedRemediation: remedy,
+		AdditionalInfo:       additionalInfo,
+	}
+}
+
 func (e *Error) Error() string { return strings.Join(e.LongDescription[:], ".") }
 
+func (e *Error) ErrorV2(additionalInfo interface{}) ErrorV2 {
+	return ErrorV2{Code: e.Code, Severity: e.Severity, ShortDescription: e.ShortDescription, LongDescription: e.LongDescription, ProbableCause: e.ProbableCause, SuggestedRemediation: e.SuggestedRemediation, AdditionalInfo: additionalInfo}
+}
+
 func GetCode(err error) string {
 	if obj := err.(*Error); obj != nil && obj.Code != " " {
 		return obj.Code

errors/types.go

@@ -9,6 +9,22 @@ type (
 		ProbableCause        []string
 		SuggestedRemediation []string
 	}
+	// Limitations of Error struct defined above:
+	// There are different types of Errors. Each type of error contains different information.
+	// Short and Long Descriptions accept only strings and so they cannot contain structured information.
+	// e.g. The Validation Error information (instancePath, badValue etc.) cannot be contained in Error struct (or not in a structured way that the clients can make use of it)
+	//
+	// ErrorV2 struct adds the ability to express all different types of errors.
+	// ErrorV2 is backwards compatible with Error struct
+	ErrorV2 struct {
+		Code                 string
+		Severity             Severity
+		ShortDescription     []string
+		LongDescription      []string
+		ProbableCause        []string
+		SuggestedRemediation []string
+		AdditionalInfo       interface{}
+	}
 )
 
 type Severity int
@@ -19,7 +35,6 @@ const (
 	Alert            // Immediate action needed
 	Critical         // Critical condition—default level
 	Fatal            // Fatal condition
-
 )
 
 var (