Added multiline support for @description attribute for securityDefini…

…tions (#1786)
swaggo · Apr 22, 2024 · 85254b4 · 85254b4
1 parent 4c2f8dd
commit 85254b4
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 1 deletion.
diff --git a/parser.go b/parser.go
@@ -774,7 +774,10 @@ loopline:
 
 		// Not mandatory field
 		if securityAttr == descriptionAttr {
-			description = value
+			if description != "" {
+				description += "\n"
+			}
+			description += value
 		}
 
 		// next securityDefinitions

diff --git a/parser_test.go b/parser_test.go
@@ -3864,6 +3864,24 @@ func TestTryAddDescription(t *testing.T) {
 				},
 			},
 		},
+		{
+			name: "added description with multiline",
+			lines: []string{
+				"\t@securitydefinitions.apikey test",
+				"\t@in header",
+				"\t@name x-api-key",
+				"\t@description line1",
+				"\t@description line2",
+			},
+			want: &spec.SecurityScheme{
+				SecuritySchemeProps: spec.SecuritySchemeProps{
+					Name:        "x-api-key",
+					Type:        "apiKey",
+					In:          "header",
+					Description: "line1\nline2",
+				},
+			},
+		},
 		{
 			name: "no description",
 			lines: []string{