feat(description): add required field description

It's helpful to a user to know what fields are required.

Author: toumorokoshi

internal/service/field_description_test.go

@@ -0,0 +1,54 @@
+package service
+
+import (
+	"strings"
+	"testing"
+
+	"github.com/aep-dev/aep-lib-go/pkg/api"
+	"github.com/aep-dev/aep-lib-go/pkg/openapi"
+)
+
+func TestRequiredFieldDescription(t *testing.T) {
+	resource := &api.Resource{
+		Singular: "book",
+		Plural:   "books",
+		Schema: &openapi.Schema{
+			Properties: map[string]openapi.Schema{
+				"title": {
+					Type:        "string",
+					Description: "The title of the book",
+				},
+				"author": {
+					Type:        "string",
+					Description: "The author of the book",
+				},
+			},
+			Required: []string{"title"},
+		},
+		Methods: api.Methods{
+			Create: &api.CreateMethod{},
+		},
+	}
+
+	// We can use the internal function `ExecuteResourceCommand` to get the command,
+    // but better yet, let's just inspect the flags created by `addSchemaFlags` if possible,
+    // or run `ExecuteResourceCommand` and check the help output implicitly or by inspecting the command structure.
+
+    // Since `ExecuteResourceCommand` returns a request, output, and error,
+    // and helping is handled by cobra's execution, let's try to invoke help or inspect the command.
+
+    // Actually, `ExecuteResourceCommand` creates the command internally and executes it.
+    // It does not return the cobra command.
+    // However, it sets the output to a strings.Builder.
+
+	args := []string{"create", "--help"}
+	_, output, _ := ExecuteResourceCommand(resource, args)
+
+	if !strings.Contains(output, "The title of the book (required)") {
+		t.Errorf("Expected description for required field 'title' to contain '(required)', but got:\n%s", output)
+	}
+
+	if strings.Contains(output, "The author of the book (required)") {
+		t.Errorf("Expected description for optional field 'author' NOT to contain '(required)', but got:\n%s", output)
+	}
+}

internal/service/resource_definition.go

@@ -206,6 +206,19 @@ func addSchemaFlags(c *cobra.Command, schema openapi.Schema, args map[string]int
 		if description == "" {
 			description = fmt.Sprintf("The %v of the resource", name)
 		}
+
+		// Check if the field is required
+		isRequired := false
+		for _, required := range schema.Required {
+			if required == name {
+				isRequired = true
+				break
+			}
+		}
+		if isRequired {
+			description = fmt.Sprintf("%s (required)", description)
+		}
+
 		if prop.ReadOnly {
 			continue
 		}