Comments added on the APIError struct.

solher · Nov 18, 2015 · d0d9f0c · d0d9f0c
1 parent 5d5605a
commit d0d9f0c
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/api_errors.go b/api_errors.go
@@ -4,10 +4,14 @@ import "fmt"
 
 // APIError defines the format of Zest API errors.
 type APIError struct {
-	Status      int    `json:"status"`
+	// The status code.
+	Status int `json:"status"`
+	// The description of the API error.
 	Description string `json:"description"`
-	Raw         string `json:"raw"`
-	ErrorCode   string `json:"errorCode"`
+	// A raw description of what triggered the API error.
+	Raw string `json:"raw"`
+	// The token uniquely identifying the API error.
+	ErrorCode string `json:"errorCode"`
 }
 
 func (e APIError) Error() string {