serializers

Documentation

Index

• type AddMemberSerializer
• type AddSprintTaskMemberSerializer
• type BaseRating
• type CreateSprintSerializer
• type EditLevel
• type RetroFieldsEditLevelMap
  • func (retroFieldsEditLevelMap RetroFieldsEditLevelMap) Validate() bool
• type Retrospective
• type RetrospectiveCreateSerializer
• type RetrospectiveFeedback
• type RetrospectiveFeedbackCreateSerializer
• type RetrospectiveFeedbackListSerializer
• type RetrospectiveFeedbackUpdateSerializer
• type RetrospectiveListSerializer
• type RetrospectiveUpdateSerializer
• type Sprint
  • func (sprint *Sprint) SetEditable(userID uint)
• type SprintMemberSummary
  • func (member *SprintMemberSummary) SetExpectedStoryPoint(sprint models.Sprint, retro models.Retrospective)
• type SprintMemberSummaryListSerializer
• type SprintMemberUpdate
• type SprintSummary
• type SprintTask
• type SprintTaskDone
• type SprintTaskMemberUpdate
• type SprintTaskSummary
• type SprintTaskUpdate
• type SprintTasksSerializer
• type SprintsSerializer
• type TaskMember
• type TaskMembersSerializer
• type Trail
• type TrailSerializer
• type UpdateSprintSerializer

Types

type AddMemberSerializer

type AddMemberSerializer struct {
	MemberID uint `json:"memberID" binding:"required"`
}

AddMemberSerializer ...

type AddSprintTaskMemberSerializer

type AddSprintTaskMemberSerializer struct {
	MemberID uint `json:"memberID" binding:"required"`
}

AddSprintTaskMemberSerializer ...

type BaseRating

type BaseRating struct {
	Rating *int8 `json:"Rating" binding:"omitempty,is_valid_rating"`
}

BaseRating is the base serializer for rating

type CreateSprintSerializer

type CreateSprintSerializer struct {
	Title       string     `json:"title" binding:"required"`
	SprintID    string     `json:"sprintID" binding:"is_valid_sprint"`
	StartDate   *time.Time `json:"startDate"`
	EndDate     *time.Time `json:"endDate"`
	CreatedByID uint
}

CreateSprintSerializer is used in sprint create API

type EditLevel

type EditLevel uint

EditLevel ...

const (
	NotEditable EditLevel = iota + 1
	Partially
	Fully
)

Various EditLevels ...

type RetroFieldsEditLevelMap

type RetroFieldsEditLevelMap struct {
	Title             EditLevel
	ProjectName       EditLevel
	TeamID            EditLevel
	StoryPointPerWeek EditLevel
	TimeProviderName  EditLevel
}

RetroFieldsEditLevelMap ...

func (RetroFieldsEditLevelMap) Validate

func (retroFieldsEditLevelMap RetroFieldsEditLevelMap) Validate() bool

Validate ...

type Retrospective

type Retrospective struct {
	ID                 uint
	Title              string
	ProjectName        string
	Team               userSerializer.Team
	TeamID             uint
	UpdatedAt          time.Time
	CreatedBy          userSerializer.User
	CreatedByID        uint
	CreatedAt          time.Time
	TaskProviderConfig fields.JSONB
	TimeProviderName   string
	StoryPointPerWeek  float64
}

Retrospective ...

type RetrospectiveCreateSerializer

type RetrospectiveCreateSerializer struct {
	Title              string                   `json:"title" binding:"required"`
	ProjectName        string                   `json:"projectName" binding:"required"`
	TaskProviderConfig []map[string]interface{} `json:"taskProvider" binding:"required,is_valid_task_provider_config"`
	TeamID             uint                     `json:"team" binding:"required,is_valid_team"`
	StoryPointPerWeek  float64                  `json:"storyPointPerWeek" binding:"required"`
	TimeProviderName   string                   `json:"timeProviderKey" binding:"required"`
	CreatedByID        uint
}

RetrospectiveCreateSerializer ...

type RetrospectiveFeedback

type RetrospectiveFeedback struct {
	ID              uint
	SubType         string
	Type            models.RetrospectiveFeedbackType
	RetrospectiveID uint
	Text            string
	Scope           models.RetrospectiveFeedbackScope
	AssigneeID      *uint
	Assignee        *serializers.User
	AddedAt         *time.Time
	ResolvedAt      *time.Time
	ExpectedAt      *time.Time
	CreatedByID     uint
	CreatedBy       serializers.User
}

RetrospectiveFeedback ...

type RetrospectiveFeedbackCreateSerializer

type RetrospectiveFeedbackCreateSerializer struct {
	SubType string `json:"subType" binding:"required"`
}

RetrospectiveFeedbackCreateSerializer ...

type RetrospectiveFeedbackListSerializer

type RetrospectiveFeedbackListSerializer struct {
	Feedbacks []models.RetrospectiveFeedback
}

RetrospectiveFeedbackListSerializer ...

type RetrospectiveFeedbackUpdateSerializer

type RetrospectiveFeedbackUpdateSerializer struct {
	Text       *string    `json:"Text"`
	Scope      *int8      `json:"Scope" binding:"omitempty,is_valid_retrospective_feedback_scope"`
	AssigneeID *uint      `json:"AssigneeID"`
	ExpectedAt *time.Time `json:"ExpectedAt"`
}

RetrospectiveFeedbackUpdateSerializer ...

type RetrospectiveListSerializer

type RetrospectiveListSerializer struct {
	MyRetrospectives     []Retrospective
	OthersRetrospectives []Retrospective
}

RetrospectiveListSerializer ...

type RetrospectiveUpdateSerializer

type RetrospectiveUpdateSerializer struct {
	RetroID            uint                     `json:"retroID" binding:"required"`
	Title              string                   `json:"title" binding:"required"`
	ProjectName        string                   `json:"projectName" binding:"required"`
	TaskProviderConfig []map[string]interface{} `json:"taskProvider" binding:"required,is_valid_task_provider_config"`
	TeamID             uint                     `json:"team" binding:"required,is_valid_team"`
	StoryPointPerWeek  float64                  `json:"storyPointPerWeek" binding:"required"`
	TimeProviderName   string                   `json:"timeProviderKey" binding:"required"`
	CredentialsChanged bool                     `json:"credentialsChanged"`
}

RetrospectiveUpdateSerializer ...

type Sprint

type Sprint struct {
	ID              uint
	Title           string
	SprintID        string
	Status          retroModels.SprintStatus
	StartDate       time.Time
	EndDate         time.Time
	LastSyncedAt    *time.Time
	SyncStatus      int8
	CreatedBy       userSerializer.User
	CreatedByID     uint
	RetrospectiveID uint
	Summary         SprintSummary
	Editable        *bool
	Deletable       bool
}

Sprint is a serializer used in the Get sprint APIs

func (*Sprint) SetEditable

func (sprint *Sprint) SetEditable(userID uint)

SetEditable ...

type SprintMemberSummary

type SprintMemberSummary struct {
	ID                  uint
	FirstName           string
	LastName            string
	AllocationPercent   float64
	ExpectationPercent  float64
	Vacations           float64
	Rating              uint
	Comment             string
	ActualStoryPoint    float64
	TotalTimeSpentInMin float64
	ExpectedStoryPoint  float64
}

SprintMemberSummary ...

func (*SprintMemberSummary) SetExpectedStoryPoint

func (member *SprintMemberSummary) SetExpectedStoryPoint(sprint models.Sprint, retro models.Retrospective)

SetExpectedStoryPoint ...

type SprintMemberSummaryListSerializer

type SprintMemberSummaryListSerializer struct {
	Members []*SprintMemberSummary
}

SprintMemberSummaryListSerializer ...

type SprintMemberUpdate

type SprintMemberUpdate struct {
	BaseRating
	AllocationPercent  *float64 `json:"AllocationPercent"`
	ExpectationPercent *float64 `json:"ExpectationPercent"`
	Vacations          *float64 `json:"Vacations"`
	Comment            *string  `json:"Comment"`
}

SprintMemberUpdate serializer to update a sprint member

type SprintSummary

type SprintSummary struct {
	MemberCount      int
	TotalAllocation  float64
	TotalExpectation float64
	TotalOutput      float64
	Holidays         float64
	TotalVacations   float64
	TargetSP         float64
	TaskSummary      map[string]SprintTaskSummary
}

SprintSummary ...

type SprintTask

type SprintTask struct {
	ID                      uint
	Key                     string
	URL                     string
	Summary                 string
	Description             string
	Type                    string
	Status                  string
	Priority                string
	IsTrackerTask           bool
	IsInvalid               bool
	Rating                  int8
	Estimate                float64
	TotalPointsEarned       float64
	PointsEarned            float64
	Assignee                string // Assignee of the task
	Owner                   string // Owner of the task across the sprints
	TaskParticipants        string // Participants of the task across the sprints
	SprintOwner             string // Owner of the task in the sprint
	SprintParticipants      string // Participants of the task in the current sprint
	SprintCurrentMemberTime uint   // Time spent on the task by the Current Login Member in the sprint
	SprintOwnerTime         uint   // Time spent on the task by the Sprint Owner in the sprint
	SprintOwnerTotalTime    uint   // Total time spent on the task by the Sprint Owner across the sprints
	SprintTime              uint   // Time spent on the task in the sprint
	TotalTime               uint   // Total time spent on the task across the sprints
	DoneAt                  *time.Time
	Resolution              int8
}

SprintTask ...

type SprintTaskDone

type SprintTaskDone struct {
	Resolution *int8 `json:"Resolution" binding:"omitempty,is_valid_resolution"`
}

SprintTaskDone ...

type SprintTaskMemberUpdate

type SprintTaskMemberUpdate struct {
	BaseRating
	SprintPoints *float64 `json:"SprintPoints"`
	Comment      *string  `json:"Comment"`
	Role         *int8    `json:"Role" binding:"omitempty,is_valid_task_role"`
}

SprintTaskMemberUpdate serializer to update

type SprintTaskSummary

type SprintTaskSummary struct {
	Count             uint
	TotalCount        uint
	PointsEarned      float64
	TotalPointsEarned float64
	ActualHours       uint
}

SprintTaskSummary ...

type SprintTaskUpdate

type SprintTaskUpdate struct {
	BaseRating
}

SprintTaskUpdate ...

type SprintTasksSerializer

type SprintTasksSerializer struct {
	Tasks []*SprintTask
}

SprintTasksSerializer ...

type SprintsSerializer

type SprintsSerializer struct {
	Sprints []Sprint
}

SprintsSerializer ...

type TaskMember

type TaskMember struct {
	ID           uint
	FirstName    string
	LastName     string
	TotalTime    uint
	SprintTime   uint
	TotalPoints  float64
	SprintPoints float64
	Rating       int8
	Comment      string
	Role         int8
	Current      bool
}

TaskMember ...

type TaskMembersSerializer

type TaskMembersSerializer struct {
	Members []TaskMember
}

TaskMembersSerializer ...

type Trail

type Trail struct {
	Action       string
	ActionItem   string
	ActionItemID uint
	ActionBy     userModels.User
	ActionByID   uint
	CreatedAt    time.Time
}

Trail .......

type TrailSerializer

type TrailSerializer struct {
	Trails []Trail
}

TrailSerializer used to get trails ...

type UpdateSprintSerializer

type UpdateSprintSerializer struct {
}

UpdateSprintSerializer is used in sprint create API