groups

Documentation

Overview

Package groups ...

Index

• type Entity
  • func FindByParams(orm *xorm.Engine, params *getGroupParams) ([]Entity, error)
  • func (e *Entity) ExtractFrom(orm *xorm.Engine) error
  • func (e *Entity) Save(orm *xorm.Engine) error
  • func (e *Entity) TableName() string
• type Handler
  • func (h *Handler) GetGroups(c echo.Context) error

Types

type Entity

type Entity struct {
	ID      uint64 `json:"id" xorm:"'id' pk index autoincr"`
	Created uint64 `json:"created" xorm:"'created'"`
	Updated uint64 `json:"updated" xorm:"'updated'"`
	Name    string `json:"name" xorm:"index unique 'name'"`
	Note    string `json:"note"`
}

Entity represents group

func FindByParams

func FindByParams(orm *xorm.Engine, params *getGroupParams) ([]Entity, error)

FindByParams return groups that matches params

func (*Entity) ExtractFrom

func (e *Entity) ExtractFrom(orm *xorm.Engine) error

ExtractFrom extracts group from database with strict data

func (*Entity) Save

func (e *Entity) Save(orm *xorm.Engine) error

Save group

func (*Entity) TableName

func (e *Entity) TableName() string

TableName is used by xorm to set a table name for this entity

type Handler

type Handler struct {
	C *ctx.Context
}

Handler is a application context carrier

func (*Handler) GetGroups

func (h *Handler) GetGroups(c echo.Context) error

GetGroups is a GET /groups handler swagger:operation GET /groups groups GetGroups

Returns groups list

--- responses:

200:
  description: returns group array
  schema:
    type: array
    items:
      $ref: '#/definitions/GroupEntity'