2019-05-01 11:44:45 +00:00
|
|
|
package api
|
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
|
|
|
)
|
|
|
|
|
2021-03-28 16:49:23 +00:00
|
|
|
// Err represents an http response error following the api format.
|
2019-05-02 05:54:45 +00:00
|
|
|
// These are used by the services to set the *execution status*
|
2019-05-01 11:44:45 +00:00
|
|
|
// directly into the response as JSON alongside response output fields.
|
2021-03-28 16:49:23 +00:00
|
|
|
type Err struct {
|
|
|
|
// error code (unique)
|
|
|
|
Code int `json:"code"`
|
|
|
|
// error small description
|
|
|
|
Reason string `json:"reason"`
|
|
|
|
// associated HTTP status
|
2021-05-18 09:10:12 +00:00
|
|
|
Status int `json:"-"`
|
2020-04-04 14:03:50 +00:00
|
|
|
}
|
|
|
|
|
2021-03-28 16:49:23 +00:00
|
|
|
func (e Err) Error() string {
|
|
|
|
return fmt.Sprintf("[%d] %s", e.Code, e.Reason)
|
2019-05-01 11:44:45 +00:00
|
|
|
}
|