errors

Documentation

Index

• type APIError
  • func AppAlreadyKnown(app string) APIError
  • func AppChartIsNotKnown(appChart string) APIError
  • func AppIsNotKnown(app string) APIError
  • func ConfigurationAlreadyKnown(configuration string) APIError
  • func ConfigurationIsNotKnown(configuration string) APIError
  • func InternalError(err error, details ...string) APIError
  • func NamespaceAlreadyKnown(namespace string) APIError
  • func NamespaceIsNotKnown(namespace string) APIError
  • func NewAPIError(title string, status int) APIError
  • func NewBadRequestError(msg string) APIError
  • func NewBadRequestErrorf(format string, values ...any) APIError
  • func NewConflictError(kind, name string) APIError
  • func NewInternalError(msg string, details ...string) APIError
  • func NewNotFoundError(kind, name string) APIError
  • func ServiceAlreadyKnown(service string) APIError
  • func ServiceIsNotKnown(service string) APIError
  • func (a APIError) Error() string
  • func (a APIError) Errors() []APIError
  • func (a APIError) FirstStatus() int
  • func (a APIError) WithDetails(details string) APIError
  • func (a APIError) WithDetailsf(format string, values ...any) APIError
• type APIErrors
• type ErrorResponse
• type MultiError
  • func NewMultiError(errs []APIError) MultiError
  • func (m MultiError) Error() string
  • func (m MultiError) Errors() []APIError
  • func (m MultiError) FirstStatus() int

Types

type APIError

type APIError struct {
	Status  int    `json:"status"`
	Title   string `json:"title"`
	Details string `json:"details"`
}

APIError fulfills the error and APIErrors interfaces. It contains a single error.

func AppAlreadyKnown

func AppAlreadyKnown(app string) APIError

AppAlreadyKnown constructs an API error for when we have a conflict with an existing app

func AppChartIsNotKnown

func AppChartIsNotKnown(appChart string) APIError

AppChartIsNotKnown constructs an API error for when the desired app chart does not exist

func AppIsNotKnown

func AppIsNotKnown(app string) APIError

AppIsNotKnown constructs an API error for when the desired app does not exist

func ConfigurationAlreadyKnown

func ConfigurationAlreadyKnown(configuration string) APIError

ConfigurationAlreadyKnown constructs an API error for when we have a conflict with an existing configuration instance

func ConfigurationIsNotKnown

func ConfigurationIsNotKnown(configuration string) APIError

ConfigurationIsNotKnown constructs an API error for when the desired configuration instance does not exist

func InternalError

func InternalError(err error, details ...string) APIError

InternalError constructs an API error for server internal issues, from a lower-level error

func NamespaceAlreadyKnown

func NamespaceAlreadyKnown(namespace string) APIError

NamespaceAlreadyKnown constructs an API error for when we have a conflict with an existing namespace

func NamespaceIsNotKnown

func NamespaceIsNotKnown(namespace string) APIError

NamespaceIsNotKnown constructs an API error for when the desired namespace does not exist

func NewAPIError

func NewAPIError(title string, status int) APIError

NewAPIError constructs an APIerror from basics

func NewBadRequestError

func NewBadRequestError(msg string) APIError

NewBadRequestError constructs an API error for general issues with a request, from a message

func NewBadRequestErrorf

func NewBadRequestErrorf(format string, values ...any) APIError

NewBadRequestErrorf constructs an API error for general issues with a request, with a formatted message

func NewConflictError

func NewConflictError(kind, name string) APIError

NewConflictError constructs a general API error for when something conflicts

func NewInternalError

func NewInternalError(msg string, details ...string) APIError

NewInternalError constructs an API error for server internal issues, from a message

func NewNotFoundError

func NewNotFoundError(kind, name string) APIError

NewNotFoundError constructs a general API error for when something desired does not exist

func ServiceAlreadyKnown

func ServiceAlreadyKnown(service string) APIError

ServiceAlreadyKnown constructs an API error for when we have a conflict with an existing service instance

func ServiceIsNotKnown

func ServiceIsNotKnown(service string) APIError

ServiceIsNotKnown constructs an API error for when the desired service does not exist

func (APIError) Error

func (a APIError) Error() string

Error satisfies the error interface

func (APIError) Errors

func (a APIError) Errors() []APIError

Errors satisfies the APIErrors interface

func (APIError) FirstStatus

func (a APIError) FirstStatus() int

FirstStatus (APIErrors interface) returns the stored error's status

func (APIError) WithDetails

func (a APIError) WithDetails(details string) APIError

WithDetails returns a new error with the provided details

func (APIError) WithDetailsf

func (a APIError) WithDetailsf(format string, values ...any) APIError

WithDetailsf returns a new error with the provided details formatted as specified

type APIErrors

type APIErrors interface {
	Errors() []APIError
	FirstStatus() int
}

APIErrors is the interface used by all handlers to return one or more errors

type ErrorResponse

type ErrorResponse struct {
	Errors []APIError `json:"errors"`
}

ErrorResponse is the response's JSON, that is send in case of an error

type MultiError

type MultiError struct {
	// contains filtered or unexported fields
}

MultiError fulfills the APIErrors interface. It contains multiple errors.

func NewMultiError

func NewMultiError(errs []APIError) MultiError

NewMultiError constructs an APIerror from basics

func (MultiError) Error

func (m MultiError) Error() string

Error satisfies the error interface

func (MultiError) Errors

func (m MultiError) Errors() []APIError

Errors satisfies the APIErrors interface

func (MultiError) FirstStatus

func (m MultiError) FirstStatus() int

FirstStatus (APIErrors interface) returns the status of the first error stored