model

Documentation

Index

• Variables
• type LoginRequest
• type LoginResponse
• type User

Variables

var (
	// ErrNotFound represents a resource not found (404)
	ErrNotFound = errors.New("not found")

	// ErrUnauthorized represents a Forbidden (403)
	ErrUnauthorized = errors.New("unauthorized")

	// ErrEmpty is returned when input string is empty
	ErrEmpty = errors.New("empty string")
)

Types

type LoginRequest

type LoginRequest struct {
	Username string `json:"username" pact:"example=sally"`
	Password string `json:"password" pact:"example=badpassword"`
}

LoginRequest is the login request API struct.

type LoginResponse

type LoginResponse struct {
	User *User `json:"user"`
}

LoginResponse is the login response API struct.

type User

type User struct {
	FirstName string `json:"firstName" pact:"example=Sally"`
	LastName  string `json:"lastName" pact:"example=McSmiley Face😀😍"`
	Username  string `json:"username" pact:"example=sally"`
	Type      string `json:"type" pact:"example=admin,regex=^(admin|user|guest)$"`
	ID        int    `json:"id" pact:"example=10"`
}

User is a representation of a User. Dah.