feat: add description to schema object defs

docs: run doc codegen Signed-off-by: Mathspy <[email protected]> Signed-off-by: Noel Georgi <[email protected]>
siderolabs · Feb 20, 2025 · f5c0970 · f5c0970
1 parent 79ee304
commit f5c0970
Show file tree

Hide file tree

Showing 3 changed files with 403 additions and 200 deletions.
diff --git a/hack/docgen/schema.go b/hack/docgen/schema.go
@@ -261,6 +261,9 @@ func structToSchema(pkg string, st *Struct) *jsonschema.Schema {
 
 	schema.Properties = properties
 	schema.Required = requiredFields
+	if st.Text.Description != "" {
+		schema.Description = st.Text.Description
+	}
 
 	return &schema
 }