api

Documentation

Index

• func InitAdminRouter(apiHelper Helper)
• func InitAdminUI(apiHelper Helper)
• func InitLoginRoute(apiHelper Helper, loginMode string, authURL string, jwtSecret string)
• func InitSourcesRouter(apiHelper Helper)
• func InitTestRouter(api Helper)
• func ReadRequest(c context.Context, w http.ResponseWriter, r heligo.Request) (records []database.Record, status int, err error)
• func SetResponseHeaders(ctx context.Context, w http.ResponseWriter, r heligo.Request, count int64) int
• func StripPrefix(r *http.Request, prefix string) *http.Request
• func TableCreateHandler(c context.Context, w http.ResponseWriter, r heligo.Request) (int, error)
• func TableDeleteHandler(c context.Context, w http.ResponseWriter, r heligo.Request) (int, error)
• func TableGetHandler(c context.Context, w http.ResponseWriter, r heligo.Request) (int, error)
• func TableListHandler(c context.Context, w http.ResponseWriter, r heligo.Request) (int, error)
• func TableUpdateHandler(c context.Context, w http.ResponseWriter, r heligo.Request) (int, error)
• func WriteBadRequest(w http.ResponseWriter, err error) (int, error)
• func WriteContent(ctx context.Context, w http.ResponseWriter, status int, content []byte) (int, error)
• func WriteError(w http.ResponseWriter, err error) (int, error)
• func WriteServerError(w http.ResponseWriter, err error) (int, error)
• type AccessTokenResponse
• type Credentials
• type Helper
• type SmoothError
• type User
• type WeakPasswordError
  • func (e *WeakPasswordError) Error() string

Functions

func InitAdminRouter

func InitAdminRouter(apiHelper Helper)

func InitAdminUI

func InitAdminUI(apiHelper Helper)

func InitLoginRoute

func InitLoginRoute(apiHelper Helper, loginMode string, authURL string, jwtSecret string)

func InitSourcesRouter

func InitSourcesRouter(apiHelper Helper)

func InitTestRouter

func InitTestRouter(api Helper)

func ReadRequest

func ReadRequest(c context.Context, w http.ResponseWriter, r heligo.Request) (records []database.Record, status int, err error)

ReadRequest reads the input data from a request and manage the preconditions. It will emit BadRequest (400), RequestEntityTooLarge (413) or UnsupportedMediaType (415) status when appropriate. Supports JSON, CSV and x-www-form-urlencoded input data.

func SetResponseHeaders

func SetResponseHeaders(ctx context.Context, w http.ResponseWriter, r heligo.Request, count int64) int

SetResponseHeaders sets the response headers (for now Content-Range and Content-Location). It returns a status != 0 if some contraints are not satisfied and we need to include an error status in the response (eg 416 for RequestedRangeNotSatisfiable)

func StripPrefix

func StripPrefix(r *http.Request, prefix string) *http.Request

StripPrefix returns a new request with the URL path stripped from a prefix. It returns nil if the URL path has nbot been stripped. Taken from the handler version in the standard lib: http.StripPrefix.

func TableCreateHandler

func TableCreateHandler(c context.Context, w http.ResponseWriter, r heligo.Request) (int, error)

func TableDeleteHandler

func TableDeleteHandler(c context.Context, w http.ResponseWriter, r heligo.Request) (int, error)

func TableGetHandler

func TableGetHandler(c context.Context, w http.ResponseWriter, r heligo.Request) (int, error)

func TableListHandler

func TableListHandler(c context.Context, w http.ResponseWriter, r heligo.Request) (int, error)

func TableUpdateHandler

func TableUpdateHandler(c context.Context, w http.ResponseWriter, r heligo.Request) (int, error)

func WriteBadRequest

func WriteBadRequest(w http.ResponseWriter, err error) (int, error)

WriteBadRequest writes a BadRequest or StatusRequestEntityTooLarge status

func WriteContent

func WriteContent(ctx context.Context, w http.ResponseWriter, status int, content []byte) (int, error)

WriteContent writes the response and its content type

func WriteError

func WriteError(w http.ResponseWriter, err error) (int, error)

WriteError is the more general error function, combining the previous two.

func WriteServerError

func WriteServerError(w http.ResponseWriter, err error) (int, error)

WriteServerError write a status related to a database error

Types

type AccessTokenResponse

type AccessTokenResponse struct {
	Token                string             `json:"access_token"`
	TokenType            string             `json:"token_type"` // Bearer
	ExpiresIn            int                `json:"expires_in"`
	ExpiresAt            int64              `json:"expires_at"`
	RefreshToken         string             `json:"refresh_token"`
	User                 *User              `json:"user"`
	ProviderAccessToken  string             `json:"provider_token,omitempty"`
	ProviderRefreshToken string             `json:"provider_refresh_token,omitempty"`
	WeakPassword         *WeakPasswordError `json:"weak_password,omitempty"`
}

type Credentials

type Credentials struct {
	Email    string `json:"email"`
	Phone    string `json:"phone"`
	Password string `json:"password"`
}

type Helper

type Helper interface {
	GetDBE() *database.DbEngine
	GetDatabase(context.Context, string) (*database.Database, error)
	GetMainDatabase(context.Context) (*database.Database, error)

	GetRouter() *heligo.Router
	MiddlewareStd() heligo.Middleware
	MiddlewareDBE() heligo.Middleware
	MiddlewareWithDbName(string) heligo.Middleware

	BaseAdminURL() string
	BaseAPIURL() string
	HasShortAPIURL() bool

	SessionStatistics() authn.SessionStatistics
}

type SmoothError

type SmoothError struct {
	Subsystem string `json:"subsystem"`
	Message   string `json:"message"`
	Code      string `json:"code"`
	Hint      string `json:"hint"`
	Details   any    `json:"details"`
	Position  int32  `json:"position"`
}

SmoothError is the generic struct for error reporting

type User

type User struct {
	Aud   string `json:"aud"`
	Role  string `json:"role"`
	Email string `json:"email"`
}

type WeakPasswordError

type WeakPasswordError struct {
	Message string   `json:"message,omitempty"`
	Reasons []string `json:"reasons,omitempty"`
}

func (*WeakPasswordError) Error

func (e *WeakPasswordError) Error() string