style: add godocs

api/constants.go

@@ -1,9 +1,13 @@
 package api
 
+// SortOrder represents the sorting order for entities.
 type SortOrder string
 
 const (
-	NoSortOrder   SortOrder = ""
-	AscSortOrder  SortOrder = "asc"
+	// NoSortOrder means that entities may be unsorted.
+	NoSortOrder SortOrder = ""
+	// AscSortOrder means that entities should be ordered ascending (example: from 1 to 9).
+	AscSortOrder SortOrder = "asc"
+	// DescSortOrder means that entities should be ordered descending (example: from 9 to 1).
 	DescSortOrder SortOrder = "desc"
 )

api/dto/team.go

@@ -95,27 +95,33 @@ func (TeamMembers) Render(w http.ResponseWriter, r *http.Request) error {
 	return nil
 }
 
+// TeamSettings is a structure that contains info about team: contacts and subscriptions.
 type TeamSettings struct {
 	TeamID        string                   `json:"team_id" example:"d5d98eb3-ee18-4f75-9364-244f67e23b54"`
 	Contacts      []moira.ContactData      `json:"contacts"`
 	Subscriptions []moira.SubscriptionData `json:"subscriptions"`
 }
 
+// Render is a function that implements chi Renderer interface for TeamSettings.
 func (TeamSettings) Render(w http.ResponseWriter, r *http.Request) error {
 	return nil
 }
 
+// TeamsList is a structure that represents a list of existing teams in db.
 type TeamsList struct {
 	List  []TeamModel `json:"list"`
 	Page  *int64      `json:"page,omitempty" format:"int64" extensions:"x-nullable"`
 	Size  *int64      `json:"size,omitempty" format:"int64" extensions:"x-nullable"`
 	Total *int64      `json:"total,omitempty" format:"int64" extensions:"x-nullable"`
 }
 
+// Render is a function that implements chi Renderer interface for TeamsList.
 func (TeamsList) Render(w http.ResponseWriter, r *http.Request) error {
 	return nil
 }
 
+// NewTeamsList constructs TeamsList out of []moira.Team.
+// TeamsList.Page, TeamsList.Size and TeamsList.Total are not filled.
 func NewTeamsList(teams []moira.Team) TeamsList {
 	models := make([]TeamModel, 0, len(teams))