error_registry_entry.go

package restapi

// ErrorRegistryEntry binds an application error code to the HTTP status code
// and human-readable message that should be returned when that error is raised.
//
// Entries are registered in an [ErrorRegistry] and looked up at response time
// by [API.Error], [API.Abort], and [API.NewError].
type ErrorRegistryEntry struct {
	// StatusCode is the HTTP status code to return.
	StatusCode int `json:"statusCode"`

	// ErrorCode is the application error code that identifies the entry.
	// It is distinct from StatusCode: many application codes may map to the
	// same HTTP status.
	ErrorCode int `json:"errorCode"`

	// Message is the default human-readable message for the entry. Callers
	// may override it per-response with [WithMessage].
	Message string `json:"message"`
}

// Response returns a new [ErrorResponse] initialised with the entry's
// ErrorCode and Message. It is the canonical way to turn a registry entry
// into a response body component.
func (e ErrorRegistryEntry) Response() ErrorResponse {
	return ErrorResponse{Code: e.ErrorCode, Message: e.Message}
}