AddDescription update and test

go-fuego · Dec 9, 2024 · 1e6d931 · 1e6d931
1 parent 63cf58a
commit 1e6d931
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/option.go b/option.go
@@ -225,7 +225,7 @@ func OptionDescription(description string) func(*BaseRoute) {
 // like the controller function name and the package name.
 func OptionAddDescription(description string) func(*BaseRoute) {
 	return func(r *BaseRoute) {
-		r.Operation.Description += description
+		r.Operation.Description += "\n\n" + description
 	}
 }
 

diff --git a/option_test.go b/option_test.go
@@ -682,3 +682,16 @@ func TestSecurity(t *testing.T) {
 		require.Equal(t, []string{"basic"}, security["ApiKey"])
 	})
 }
+
+func TestOptionAddDescription(t *testing.T) {
+	t.Run("Declare a description for the route with multiple descriptions", func(t *testing.T) {
+		s := fuego.NewServer()
+
+		route := fuego.Get(s, "/test", helloWorld,
+			fuego.OptionDescription("test description"),
+			fuego.OptionAddDescription("another description"),
+		)
+
+		require.Equal(t, "controller: `github.com/go-fuego/fuego_test.helloWorld`\n\n---\n\ntest description\n\nanother description", route.Operation.Description)
+	})
+}