allow object support for "header" param to for backward compatibility (#2178)

Co-authored-by: SergeiSadov <>

Author: SergeiSadov

operationv3.go

@@ -367,7 +367,7 @@ func (o *OperationV3) ParseParamComment(commentLine string, astFile *ast.File) e
 	param := createParameterV3(paramType, description, name, objectType, refType, required, enums, o.parser.collectionFormatInQuery)
 
 	switch paramType {
-	case "path", "header":
+	case "path":
 		switch objectType {
 		case ARRAY:
 			if !IsPrimitiveType(refType) {
@@ -376,7 +376,7 @@ func (o *OperationV3) ParseParamComment(commentLine string, astFile *ast.File) e
 		case OBJECT:
 			return fmt.Errorf("%s is not supported type for %s", refType, paramType)
 		}
-	case "query":
+	case "query", "header":
 		switch objectType {
 		case ARRAY:
 			if !IsPrimitiveType(refType) && !(refType == "file" && paramType == "formData") {

operationv3_test.go

@@ -942,6 +942,96 @@ func TestOperation_ParseParamCommentV3(t *testing.T) {
 		assert.True(t, tFound, "results should contain t")
 		assert.True(t, t2Found, "results should contain t2")
 	})
+
+	t.Run("struct headers", func(t *testing.T) {
+		t.Parallel()
+		parser := New()
+		parser.packages.uniqueDefinitions["main.Object"] = &TypeSpecDef{
+			File: &ast.File{Name: &ast.Ident{Name: "test"}},
+			TypeSpec: &ast.TypeSpec{
+				Name:       &ast.Ident{Name: "Field"},
+				TypeParams: &ast.FieldList{List: []*ast.Field{{Names: []*ast.Ident{{Name: "T"}}}}},
+				Type: &ast.StructType{
+					Struct: 100,
+					Fields: &ast.FieldList{
+						List: []*ast.Field{
+							{
+								Names: []*ast.Ident{
+									{Name: "T"},
+								},
+								Type: ast.NewIdent("string"),
+							},
+							{
+								Names: []*ast.Ident{
+									{Name: "T2"},
+								},
+								Type: ast.NewIdent("string"),
+							},
+						},
+					},
+				},
+			},
+		}
+		o := NewOperationV3(parser)
+		err := o.ParseComment(`@Param some_object header main.Object true "Some Object"`,
+			nil)
+
+		assert.NoError(t, err)
+
+		expectedT := &spec.RefOrSpec[spec.Extendable[spec.Parameter]]{
+			Spec: &spec.Extendable[spec.Parameter]{
+				Spec: &spec.Parameter{
+					Name: "t",
+					In:   "header",
+					Schema: &spec.RefOrSpec[spec.Schema]{
+						Spec: &spec.Schema{
+							JsonSchema: spec.JsonSchema{
+								JsonSchemaCore: spec.JsonSchemaCore{
+									Type: &typeString,
+								},
+							},
+						},
+					},
+				},
+			},
+		}
+		expectedT2 := &spec.RefOrSpec[spec.Extendable[spec.Parameter]]{
+			Spec: &spec.Extendable[spec.Parameter]{
+				Spec: &spec.Parameter{
+					Name: "t2",
+					In:   "header",
+					Schema: &spec.RefOrSpec[spec.Schema]{
+						Spec: &spec.Schema{
+							JsonSchema: spec.JsonSchema{
+								JsonSchemaCore: spec.JsonSchemaCore{
+									Type: &typeString,
+								},
+							},
+						},
+					},
+				},
+			},
+		}
+
+		assert.Len(t, o.Parameters, 2)
+		tFound := false
+		t2Found := false
+		for _, param := range o.Parameters {
+			switch param.Spec.Spec.Name {
+			case "t":
+				assert.EqualValues(t, expectedT, param)
+				tFound = true
+			case "t2":
+				assert.EqualValues(t, expectedT2, param)
+				t2Found = true
+			default:
+				assert.Fail(t, "unexpected result")
+			}
+		}
+
+		assert.True(t, tFound, "results should contain t")
+		assert.True(t, t2Found, "results should contain t2")
+	})
 }
 
 // Test ParseParamComment Query Params