chore: godoc for ListDTO

moira-alert · Feb 4, 2025 · 4d3017d · 4d3017d
1 parent a1bdca0
commit 4d3017d
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 7 deletions.
diff --git a/api/dto/contact.go b/api/dto/contact.go
@@ -66,7 +66,7 @@ func (*ContactNoisiness) Render(w http.ResponseWriter, r *http.Request) error {
 }
 
 // ContactNoisinessList represents list of ContactNoisiness.
-type ContactNoisinessList ListDto[*ContactNoisiness]
+type ContactNoisinessList ListDTO[*ContactNoisiness]
 
 func (*ContactNoisinessList) Render(w http.ResponseWriter, r *http.Request) error {
 	return nil

diff --git a/api/dto/list.go b/api/dto/list.go
@@ -6,13 +6,18 @@ import (
 	"github.com/go-chi/render"
 )
 
-type ListDto[T render.Renderer] struct {
-	List  []T   `json:"list"`
-	Page  int64 `json:"page" example:"0" format:"int64"`
-	Size  int64 `json:"size" example:"100" format:"int64"`
+// ListDTO is a generic struct to create list types dto.
+type ListDTO[T render.Renderer] struct {
+	// List of entities.
+	List []T `json:"list"`
+	// Page number.
+	Page int64 `json:"page" example:"0" format:"int64"`
+	// Size is the amount of entities per Page.
+	Size int64 `json:"size" example:"100" format:"int64"`
+	// Total amount of entities in the database.
 	Total int64 `json:"total" example:"10" format:"int64"`
 }
 
-func (*ListDto[T]) Render(w http.ResponseWriter, r *http.Request) error {
+func (*ListDTO[T]) Render(w http.ResponseWriter, r *http.Request) error {
 	return nil
 }
diff --git a/api/dto/triggers.go b/api/dto/triggers.go
@@ -612,7 +612,7 @@ func (*TriggerNoisiness) Render(http.ResponseWriter, *http.Request) error {
 }
 
 // TriggerNoisinessList represents list of TriggerNoisiness.
-type TriggerNoisinessList ListDto[*TriggerNoisiness]
+type TriggerNoisinessList ListDTO[*TriggerNoisiness]
 
 func (*TriggerNoisinessList) Render(http.ResponseWriter, *http.Request) error {
 	return nil