problems

type BasicProblem struct {
	// Type, a URI reference that identifies the problem type.
	// When dereferenced this should provide human-readable documentation for the
	// problem type. When member is not present it is assumed to be "about:blank".
	Type string `json:"type" format:"url"`

	// Title, a short, human-readable summary of the problem type.
	// This should always be the same value for the same Type.
	Title string `json:"title"`

	// Status, the HTTP status code associated with this problem occurrence.
	Status int `json:"status,omitempty"`

	// Detail, a human-readable explanation specific to this occurrence of the problem.
	Detail string `json:"detail,omitempty"`

	// Instance, a URI reference that identifies the specific resource on which the problem occurred.
	Instance string `json:"instance,omitempty" format:"url"`

	// CorrelationID, an unique identifier for tracing this issue in server logs.
	CorrelationID string `json:"correlationId,omitempty"`
}

type InternalProblem struct {
	BasicProblem
	// contains filtered or unexported fields
}

type Problem interface {
	error

	// ProblemType, a URI reference that identifies the problem type.
	// When dereferenced this should provide human-readable documentation for the
	// problem type. When member is not present it is assumed to be "about:blank".
	ProblemType() string

	// ProblemTitle, a short, human-readable summary of the problem type.
	// This should always be the same value for the same Type.
	ProblemTitle() string

	// ProblemStatus, the HTTP status code associated with this problem occurrence.
	// If the problem returns 0, it will be set to http.StatusInternalServerError.
	ProblemStatus() int
}

type RequestDecoratableProblem interface {
	Problem

	// DecorateWithRequest, attempt to decorate the Problem with information from the request.
	DecorateWithRequest(ctx context.Context, r *http.Request)
}

type ValidationProblem struct {
	BasicProblem
	Reasons []ValidationReason `json:"reasons,omitempty"`
}

type ValidationReason struct {
	Name   string `json:"name"`
	Reason string `json:"reason"`
	Cause  error  `json:"-"`
}