Function WriteError

http/jsonapi/runtime/error.go:80–118

WriteError writes a jsonapi error message to the client

(w http.ResponseWriter, code int, err error)

// WriteError writes a jsonapi error message to the client
func WriteError(w http.ResponseWriter, code int, err error) {
	w.Header().Set("Content-Type", JSONAPIContentType)
	w.WriteHeader(code)

	// convert error type for marshaling
	var errList errorObjects

	switch v := err.(type) {
	case Error:
		errList.List = append(errList.List, &v)
	case *Error:
		errList.List = append(errList.List, v)
	case Errors:
		errList.List = v
	default:
		errList.List = []*Error{
			{Title: err.Error()},
		}
	}

	reqID := w.Header().Get("Request-Id")

	// update the http status code of the error
	errList.List.setHTTPStatus(code)

	// log all errors send to clients
	log.Logger().Debug().Str("req_id", reqID).
		Err(errList.List).Msg("error sent to client")
	errList.List.setID(reqID)

	// render the error to the client
	enc := json.NewEncoder(w)
	enc.SetIndent("", "  ")
	err = enc.Encode(errList)
	if err != nil {
		log.Logger().Info().Str("req_id", reqID).
			Err(err).Msg("Unable to send error response to the client")
	}
}

// Error objects MUST be returned as an array keyed by errors in the top level of a JSON API document.
type errorObjects struct {