api

package

v0.0.0-...-2921379 Latest Latest Go to latest Published: Jan 2, 2021 License: AGPL-3.0 Imports: 5 Imported by: 0

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 ErrIncorrectCredentials = fmt.Errorf("error authentication: invalid credentials")

View Source

var ErrUserIsDisabled = fmt.Errorf("error authentication: user login disabled")

This section is empty.

type Service struct {
	DB *db.Queries
}

Service abstracts resources to prevent mishandling.

func New(db *db.Queries) (s *Service, err error)

New initialises a new API service

func (s *Service) Login(ctx context.Context, username, password string) (db.GetUserSecureRow, error)

Login authenticates a user to the API