docs: add model docstrings (#83)

aiven · Jun 19, 2024 · 974eadc · 974eadc
1 parent 4dca345
commit 974eadc
Show file tree

Hide file tree

Showing 37 changed files with 4,309 additions and 3,271 deletions.
diff --git a/generator/main.go b/generator/main.go
@@ -457,9 +457,19 @@ func writeStruct(f *jen.File, s *Schema) error {
 		}
 
 		field = field.Tag(map[string]string{"json": strings.ReplaceAll(tag, `\`, "")})
+
+		// Adds a comment if it's not equal to the field name
+		if p.Description != "" && p.Description != p.CamelName {
+			field = field.Add(jen.Comment(p.Description))
+		}
+
 		fields = append(fields, field)
 	}
 
+	if s.Description != "" {
+		f.Comment(fmt.Sprintf("%s %s", s.CamelName, s.Description))
+	}
+
 	f.Type().Id(s.CamelName).Struct(fields...)
 
 	return nil

diff --git a/generator/models.go b/generator/models.go
@@ -139,6 +139,7 @@ type Schema struct {
 	Default       any                `json:"default"`
 	MinItems      int                `json:"minItems"`
 	Ref           string             `json:"$ref"`
+	Description   string             `json:"description"`
 	CamelName     string             `json:"for-hash-only!"`
 	required      bool
 	name          string

diff --git a/handler/account/account.go b/handler/account/account.go
diff --git a/handler/accountauthentication/accountauthentication.go b/handler/accountauthentication/accountauthentication.go
diff --git a/handler/accountteam/accountteam.go b/handler/accountteam/accountteam.go
diff --git a/handler/accountteammember/accountteammember.go b/handler/accountteammember/accountteammember.go
diff --git a/handler/applicationuser/applicationuser.go b/handler/applicationuser/applicationuser.go