apierrors

type BaseAPIError struct {
	// A unique identifier for this error. When dereferenced it must provide
	// human-readable documentation for the problem. The URL must follow
	// (#122 - Resource Names) and must not contain URI fragments type.
	Type string `json:"type"`

	// The HTTP status code of the error. Useful when passing the response body
	// to child properties in a frontend UI. Must be returned as an integer.
	Status int `json:"status"`

	// A short, human-readable summary of the problem. It should not change
	// between occurrences of a problem, except for localization. Should be
	// provided as "Sentence case" for direct use in the UI.
	Title string `json:"title"`

	// Used to return the correlation ID back to the user, in the format
	// {product}:trace:<trace_id>. This helps us find the relevant logs when a
	// customer reports an issue.
	Instance string `json:"instance"`

	// A human-readable explanation specific to this occurrence of the problem.
	// This field may contain request/entity data to help the user understand
	// what went wrong. Enclose variable values in square brackets. Should be
	// provided as "Sentence case" for direct use in the UI.
	Detail string `json:"detail"`

	// Used to indicate which fields have invalid values when validated. Both a
	// human-readable value (reason) and a type that can be used for localized
	// results (rule) are provided.
	InvalidParameters InvalidParameters `json:"invalid_parameters,omitempty"`

	// UnderlyingError is the underlying error stack to be logged.
	// NOTE: this should not be returned to callers.
	UnderlyingError error `json:"-"`
	// contains filtered or unexported fields
}

type InvalidParameter struct {
	// Field concerned by the error.
	Field string `json:"field"`

	// Rule represents the rule that has triggered the error.
	Rule string `json:"rule,omitempty"`

	// Reason describes why the error has been triggered.
	Reason string `json:"reason"`

	// Source describes where the error has been triggered: body, header, path.
	Source InvalidParameterSource `json:"source"`

	// Choices represents the available choices for value in a case of an enum.
	Choices []string `json:"choices,omitempty"`

	// Minimum is an optional field for setting the minimum required value for
	// an attribute.
	Minimum *int `json:"minimum,omitempty"`

	// Maximum is an optional field for setting the maximum required value for
	// an attribute.
	Maximum *int `json:"maximum,omitempty"`

	// Dependents is an optional field for when the rule "dependent_fields" is
	// applied.
	Dependents []string `json:"dependents,omitempty"`
}

type InvalidParameterSource uint8

type InvalidParameters []InvalidParameter