api

Documentation

Index

• Constants
• Variables
• type APIError
  • func InternalServerError(message string) *APIError
  • func NewAPIError(code int, err error) *APIError
  • func (ae *APIError) Error() string
• type APIServer
  • func NewAPIServer(apiConfig config.APIConfig, s3Service s3.DownloadUploader, ...) *APIServer
  • func (a *APIServer) StartRouter()

Constants

const MegaByte int64 = 10 << 10

Variables

var ErrDbPasswordMissing = errors.New("database password not given or found (usage: --dbpass <password> or DBPASS=<password>)")

var ErrDbUsernameMissing = errors.New("database username not given or found (usage: --dbuser <user> or DBUSER=<user>)")

Types

type APIError

type APIError struct {
	StatusCode int
	Err        error
}

func InternalServerError

func InternalServerError(message string) *APIError

TODO determine if we actually need to return a pointer

func NewAPIError

func NewAPIError(code int, err error) *APIError

func (*APIError) Error

func (ae *APIError) Error() string

type APIServer

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

func NewAPIServer

func NewAPIServer(apiConfig config.APIConfig, s3Service s3.DownloadUploader, fileService file.Storer) *APIServer

func (*APIServer) StartRouter

func (a *APIServer) StartRouter()

StartRouter starts up a Gin router for the API