Refactor Error() method to return JSON representation of APIError

ShocOne · ShocOne · commit 274880c933d7 · 2024-03-01T11:57:11.000Z
diff --git a/httpclient/httpclient_error_response.go b/httpclient/httpclient_error_response.go
@@ -30,9 +30,13 @@ type StructuredError struct {
 	} `json:"error"`
 }
 
-// Error returns a string representation of the APIError.
+// Error returns a JSON representation of the APIError.
 func (e *APIError) Error() string {
-	return fmt.Sprintf("API Error (Type: %s, Code: %d): %s", e.Type, e.StatusCode, e.Message)
+	data, err := json.Marshal(e)
+	if err != nil {
+		return fmt.Sprintf("Error encoding APIError to JSON: %s", err)
+	}
+	return string(data)
 }
 
 // handleAPIErrorResponse attempts to parse the error response from the API and logs using the zap logger.

Original file line number	Diff line number	Diff line change
`@@ -30,9 +30,13 @@ type StructuredError struct {`
`30`	`30`	} `json:"error"`
`31`	`31`	`}`
`32`	`32`
`33`		`-// Error returns a string representation of the APIError.`
	`33`	`+// Error returns a JSON representation of the APIError.`
`34`	`34`	`func (e *APIError) Error() string {`
`35`		`- return fmt.Sprintf("API Error (Type: %s, Code: %d): %s", e.Type, e.StatusCode, e.Message)`
	`35`	`+ data, err := json.Marshal(e)`
	`36`	`+ if err != nil {`
	`37`	`+ return fmt.Sprintf("Error encoding APIError to JSON: %s", err)`
	`38`	`+ }`
	`39`	`+ return string(data)`
`36`	`40`	`}`
`37`	`41`
`38`	`42`	`// handleAPIErrorResponse attempts to parse the error response from the API and logs using the zap logger.`