apiinterface

Documentation

Index

• Variables
• func HandleBadRequestError(msg string) error
• func HandleError(err error) error
• func HandleForbiddenError(msg string) error
• func HandleNotFoundError(msg string) error
• func HandleUnauthorizedError(msg string) error
• type Parameters
• type PersesContext
  • func NewPersesContext(ctx echo.Context) PersesContext
• type PersesError
  • func (e *PersesError) Error() string
• type Service

Variables

var (
	InternalError     = &PersesError{message: "internal server error"}
	NotFoundError     = &PersesError{message: "document not found"}
	ConflictError     = &PersesError{message: "document already exists"}
	BadRequestError   = &PersesError{message: "bad request"}
	UnauthorizedError = &PersesError{message: "unauthorized"}
	ForbiddenError    = &PersesError{message: "forbidden access"}
)

var (
	EmptyCtx = &context{
		username: "",
	}
)

Functions

func HandleBadRequestError

func HandleBadRequestError(msg string) error

func HandleError

func HandleError(err error) error

HandleError is translating the given error to the echo.HTTPError

func HandleForbiddenError

func HandleForbiddenError(msg string) error

func HandleNotFoundError

func HandleNotFoundError(msg string) error

func HandleUnauthorizedError

func HandleUnauthorizedError(msg string) error

Types

type Parameters

type Parameters struct {
	Project string
	Name    string
}

type PersesContext

type PersesContext interface {
	GetUsername() string
}

func NewPersesContext

func NewPersesContext(ctx echo.Context) PersesContext

type PersesError

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

func (*PersesError) Error

func (e *PersesError) Error() string

type Service

type Service[T api.Entity, K api.Entity, V databaseModel.Query] interface {
	Create(ctx PersesContext, entity T) (K, error)
	Update(ctx PersesContext, entity T, parameters Parameters) (K, error)
	Delete(ctx PersesContext, parameters Parameters) error
	Get(ctx PersesContext, parameters Parameters) (K, error)
	List(ctx PersesContext, q V, parameters Parameters) ([]K, error)
}