usererror

package
v0.0.0-...-4c964c4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 29, 2025 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// ErrInternal is returned when an internal error occurred.
	ErrInternal = New(http.StatusInternalServerError, "Internal error occurred")

	// ErrInvalidToken is returned when the api request token is invalid.
	ErrInvalidToken = New(http.StatusUnauthorized, "Invalid or missing token")

	// ErrBadRequest is returned when there was an issue with the input.
	ErrBadRequest = New(http.StatusBadRequest, "Bad Request")

	// ErrUnauthorized is returned when the acting principal is not authenticated.
	ErrUnauthorized = New(http.StatusUnauthorized, "Unauthorized")

	// ErrForbidden is returned when the acting principal is not authorized.
	ErrForbidden = New(http.StatusForbidden, "Forbidden")

	// ErrNotFound is returned when a resource is not found.
	ErrNotFound = New(http.StatusNotFound, "Not Found")

	// ErrUserPass is returned when a resource is not found.
	ErrUserPass = New(http.StatusUnauthorized, "Invalid username or password")

	// ErrPreconditionFailed is returned when a precondition failed.
	ErrPreconditionFailed = New(http.StatusPreconditionFailed, "Precondition failed")

	// ErrNotMergeable is returned when a branch can't be merged.
	ErrNotMergeable = New(http.StatusPreconditionFailed, "Branch can't be merged")

	// ErrNoChange is returned when no change was found based on the request.
	ErrNoChange = New(http.StatusBadRequest, "No Change")

	// ErrDuplicate is returned when a resource already exits.
	ErrDuplicate = New(http.StatusConflict, "Resource already exists")

	// ErrPrimaryPathCantBeDeleted is returned when trying to delete a primary path.
	ErrPrimaryPathCantBeDeleted = New(http.StatusBadRequest, "The primary path of an object can't be deleted")

	// ErrPathTooLong is returned when an action would lead to a path that is too long.
	ErrPathTooLong = New(http.StatusBadRequest, "The resource path is too long")

	// ErrCyclicHierarchy is returned if the action would create a cyclic dependency between spaces.
	ErrCyclicHierarchy = New(http.StatusBadRequest, "Unable to perform the action as it would lead to a cyclic dependency")

	// ErrSpaceWithChildsCantBeDeleted is returned if the principal is trying to delete a space that
	// still has child resources.
	ErrSpaceWithChildsCantBeDeleted = New(http.StatusBadRequest,
		"Space can't be deleted as it still contains child resources")

	// ErrDefaultBranchCantBeDeleted is returned if the user tries to delete the default branch of a repository.
	ErrDefaultBranchCantBeDeleted = New(http.StatusBadRequest, "The default branch of a repository can't be deleted")

	// ErrPullReqRefsCantBeModified is returned if a user tries to tinker with a pull request git ref.
	ErrPullReqRefsCantBeModified = New(http.StatusBadRequest, "The pull request git refs can't be modified")

	// ErrRequestTooLarge is returned if the request it too large.
	ErrRequestTooLarge = New(http.StatusRequestEntityTooLarge, "The request is too large")

	// ErrWebhookNotRetriggerable is returned if the webhook can't be retriggered.
	ErrWebhookNotRetriggerable = New(http.StatusMethodNotAllowed,
		"The webhook execution is incomplete and can't be retriggered")

	// ErrCodeOwnersNotFound is returned when codeowners file is not found.
	ErrCodeOwnersNotFound = New(http.StatusNotFound, "CODEOWNERS file not found")

	// ErrResponseNotFlushable is returned if the response writer doesn't implement http.Flusher.
	ErrResponseNotFlushable = New(http.StatusInternalServerError, "Response not streamable")

	// ErrResourceLocked is returned if the resource is locked.
	ErrResourceLocked = New(
		http.StatusLocked,
		"The requested resource is temporarily locked, please retry the operation.",
	)

	// ErrEmptyRepoNeedsBranch is returned if no branch found on the githook post receieve for empty repositories.
	ErrEmptyRepoNeedsBranch = New(http.StatusBadRequest,
		"Pushing to an empty repository requires at least one branch with commits.")

	ErrBuildInRule = New(http.StatusForbidden, "built-in rule not allow delete operation")
)

Functions

This section is empty.

Types

type Error

type Error struct {
	Status  int            `json:"-"`
	Message string         `json:"message"`
	Values  map[string]any `json:"values,omitempty"`
	Detail  string         `json:"detail"`
}

Error represents a json-encoded API error.

func BadRequest

func BadRequest(message string) *Error

BadRequest returns a new user facing bad request error.

func BadRequestWithPayload

func BadRequestWithPayload(message string, values ...map[string]any) *Error

BadRequestWithPayload returns a new user facing bad request error with payload.

func BadRequestf

func BadRequestf(format string, args ...any) *Error

BadRequestf returns a new user facing bad request error.

func Conflict

func Conflict(message string) *Error

Conflict returns a new user facing conflict error.

func ConflictWithPayload

func ConflictWithPayload(message string, values ...map[string]any) *Error

ConflictWithPayload returns a new user facing conflict error with payload.

func Forbidden

func Forbidden(message string) *Error

Forbidden returns a new user facing forbidden error.

func New

func New(status int, message string) *Error

New returns a new user facing error.

func NewWithPayload

func NewWithPayload(status int, message string, valueMaps ...map[string]any) *Error

NewWithPayload returns a new user facing error with payload.

func Newf

func Newf(status int, format string, args ...any) *Error

Newf returns a new user facing error.

func NotFound

func NotFound(message string) *Error

NotFound returns a new user facing not found error.

func NotFoundf

func NotFoundf(format string, args ...any) *Error

NotFoundf returns a new user facing not found error.

func RequestTooLargef

func RequestTooLargef(format string, args ...any) *Error

RequestTooLargef returns a new user facing request too large error.

func Translate

func Translate(ctx context.Context, err error) *Error

func UnprocessableEntityf

func UnprocessableEntityf(format string, args ...any) *Error

UnprocessableEntityf returns a new user facing unprocessable entity error.

func (*Error) Error

func (e *Error) Error() string

func (*Error) WithDetail

func (e *Error) WithDetail(detail string) *Error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL