rest

README

Structs (not objects!) shared by the REST API and the Gort client.

Documentation

Index

• type Group
• type Role
• type RolePermission
  • func (r RolePermission) String() string
• type Token
  • func (t Token) IsExpired() bool
• type User

Types

type Group

type Group struct {
	Name  string `json:"name,omitempty"`
	Users []User `json:"users,omitempty"`
}

Group is a data struct used to exchange data between a Gort client and a Gort controller's REST service.

type Role

type Role struct {
	Name        string
	Permissions []RolePermission
}

type RolePermission

type RolePermission struct {
	BundleName string
	Permission string
}

func (RolePermission) String

func (r RolePermission) String() string

type Token

type Token struct {
	Duration   time.Duration `json:"-"`
	Token      string        `json:",omitempty"`
	User       string        `json:",omitempty"`
	ValidFrom  time.Time     `json:",omitempty"`
	ValidUntil time.Time     `json:",omitempty"`
}

Token contains all of the metadata for an access token.

func (Token) IsExpired

func (t Token) IsExpired() bool

IsExpired returns true if the token has expired.

type User

type User struct {
	Email    string `json:"email,omitempty"`
	FullName string `json:"fullname,omitempty"`
	Password string `json:"password,omitempty"`
	Username string `json:"username,omitempty"`
}

User is a data struct used to exchange data between a Gort client and a Gort controller REST service.