api

package

v0.34.0 Latest Latest Go to latest Published: Mar 22, 2024 License: MIT Imports: 11 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var ErrDocumentNotFound = NotFoundError{"document not found"}

func ErrorHandler(err error, ctx echo.Context)

func GetDocumentHandler(db *database.DB) echo.HandlerFunc

func GetUserDocumentsHandler(db *database.DB) echo.HandlerFunc

func GetUserHandler(db *database.DB) echo.HandlerFunc

func GetUsersHandler(db *database.DB) echo.HandlerFunc

func ListenAndServe(ctx context.Context, e *echo.Echo, addr string) error

func NewServer(config Config) *echo.Echo

New creates a new server. Use ListenAndServe to start accepting connections.

func PatchUserHandler(db *database.DB) echo.HandlerFunc

func PostAgreementsHandler(db *database.DB) echo.HandlerFunc

func PostUserHandler(db *database.DB) echo.HandlerFunc

func PutDocumentHandler(db *database.DB) echo.HandlerFunc

type Config struct {
	DB                *database.DB
	BasicAuthUsername string
	BasicAuthPassword string
	LogWriter         io.Writer
}

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

func (ecv *EchoCustomValidator) Validate(i interface{}) error

type InternalServerError struct {
	InternalError error
}

func (err InternalServerError) Error() string

type NotFoundError struct {
	Message string
}

func (err NotFoundError) Error() string

type PatchRequest struct {
	Email    *string `json:"user_email" validate:"omitempty,email"`
	Username string  `json:"username" validate:"required"`
}

type ValidationError struct {
	ValidationErrors validator.ValidationErrors
}

func (err ValidationError) Error() string