Documentation
¶
Index ¶
- Constants
- func ApplicationNotFoundError(message string, underlyingError error) error
- func ByteArrayResponse(w http.ResponseWriter, r *http.Request, contentType string, result []byte) error
- func ErrorResponse(w http.ResponseWriter, r *http.Request, apiError error) error
- func ErrorResponseForServer(w http.ResponseWriter, r *http.Request, apiError error) error
- func ForbiddenError(message string) error
- func JSONResponse(w http.ResponseWriter, r *http.Request, result any) error
- func NotFoundError(message string) error
- func ReaderFileResponse(w http.ResponseWriter, reader io.Reader, fileName, contentType string) error
- func ReaderResponse(w http.ResponseWriter, reader io.Reader, contentType string) error
- func StringResponse(w http.ResponseWriter, r *http.Request, result string) error
- func TypeMissingError(message string, underlyingError error) error
- func UnexpectedError(message string, underlyingError error) error
- func ValidationError(kind, message string) error
- type Error
- type Type
Constants ¶
const ( // Server The operation looked fine on paper, but something went wrong Server Type = "server" // Missing The thing you mentioned, whatever it is, just doesn't exist Missing = "missing" // User The operation was well-formed, but you asked for something that // can't happen at present (e.g., because you've not supplied some // config yet) User = "user" // Forbidden The operation is not allowed for the current authenticated user Forbidden = "forbidden" )
Variables ¶
This section is empty.
Functions ¶
func ApplicationNotFoundError ¶
ApplicationNotFoundError indication that application was not found. Can also mean a user does not have access to the application.
func ByteArrayResponse ¶
func ByteArrayResponse(w http.ResponseWriter, r *http.Request, contentType string, result []byte) error
ByteArrayResponse Used for response data. I.e. image
func ErrorResponse ¶
ErrorResponse Marshals error for user requester
func ErrorResponseForServer ¶
ErrorResponseForServer Marshals error for server requester
func JSONResponse ¶
JSONResponse Marshals response with header
func ReaderFileResponse ¶
func ReaderFileResponse(w http.ResponseWriter, reader io.Reader, fileName, contentType string) error
ReaderFileResponse writes the content from the reader to the response, and sets Content-Disposition=attachment; filename=<filename arg>
func ReaderResponse ¶
ReaderResponse writes the content from the reader to the response,
func StringResponse ¶
StringResponse Used for textual response data. I.e. log data
func TypeMissingError ¶
TypeMissingError indication of underlying type missing
func UnexpectedError ¶
UnexpectedError any unexpected error
func ValidationError ¶
ValidationError Used for indication of validation errors
Types ¶
type Error ¶
type Error struct {
Type Type
// a message that can be printed out for the user
Message string `json:"message"`
// the underlying error that can be e.g., logged for developers to look at
Err error
}
Error Representation of errors in the API. These are divided into a small number of categories, essentially distinguished by whose fault the error is; i.e., is this error:
- a transient problem with the service, so worth trying again?
- not going to work until the user takes some other action, e.g., updating config?
func CoverAllError ¶
CoverAllError Cover all other errors for requester type Type
func (*Error) MarshalJSON ¶
MarshalJSON Writes error as json
func (*Error) UnmarshalJSON ¶
UnmarshalJSON Parses json
Source Files