openapi2: Use Parameter as body for Header struct

getkin · Feb 3, 2022 · a8f14c6 · a8f14c6
1 parent cea6dc6
commit a8f14c6
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 40 deletions.
diff --git a/openapi2/openapi2.go b/openapi2/openapi2.go
@@ -232,10 +232,7 @@ func (response *Response) UnmarshalJSON(data []byte) error {
 }
 
 type Header struct {
-	openapi3.ExtensionProps
-	Ref         string `json:"$ref,omitempty" yaml:"$ref,omitempty"`
-	Description string `json:"description,omitempty" yaml:"description,omitempty"`
-	Type        string `json:"type,omitempty" yaml:"type,omitempty"`
+	Parameter
 }
 
 func (header *Header) MarshalJSON() ([]byte, error) {

diff --git a/openapi2conv/openapi2_conv.go b/openapi2conv/openapi2_conv.go
@@ -431,20 +431,16 @@ func ToV3Response(response *openapi2.Response) (*openapi3.ResponseRef, error) {
 }
 
 func ToV3Headers(defs map[string]*openapi2.Header) openapi3.Headers {
-	headers := make(openapi3.Headers)
+	headers := make(openapi3.Headers, len(defs))
 	for name, header := range defs {
-		stripNonCustomExtensions(header.Extensions)
+		header.In = ""
+		header.Name = ""
 		if ref := header.Ref; ref != "" {
 			headers[name] = &openapi3.HeaderRef{Ref: ToV3Ref(ref)}
 		} else {
+			parameter, _, _, _ := ToV3Parameter(nil, &header.Parameter, nil)
 			headers[name] = &openapi3.HeaderRef{Value: &openapi3.Header{
-				Parameter: openapi3.Parameter{
-					ExtensionProps: header.ExtensionProps,
-					Description:    header.Description,
-					Schema: &openapi3.SchemaRef{Value: &openapi3.Schema{
-						Type: header.Type,
-					}},
-				},
+				Parameter: *parameter.Value,
 			}}
 		}
 	}
@@ -1074,38 +1070,27 @@ func FromV3Response(ref *openapi3.ResponseRef, components *openapi3.Components)
 		}
 	}
 	if headers := response.Headers; len(headers) > 0 {
-		result.Headers = FromV3Headers(headers, components)
+		var err error
+		if result.Headers, err = FromV3Headers(headers, components); err != nil {
+			return nil, err
+		}
 	}
 	return result, nil
 }
 
-func FromV3Headers(defs openapi3.Headers, components *openapi3.Components) map[string]*openapi2.Header {
-	headers := make(map[string]*openapi2.Header)
+func FromV3Headers(defs openapi3.Headers, components *openapi3.Components) (map[string]*openapi2.Header, error) {
+	headers := make(map[string]*openapi2.Header, len(defs))
 	for name, header := range defs {
-		if ref := header.Ref; ref != "" {
-			headers[name] = &openapi2.Header{Ref: FromV3Ref(ref)}
-		} else {
-			stripNonCustomExtensions(header.Value.Extensions)
-			var headerType string
-			if ref := header.Value.Schema.Ref; ref != "" {
-				name := getParameterNameFromNewRef(ref)
-				if val, ok := components.Schemas[name]; ok {
-					headerType = val.Value.Type
-				}
-			} else {
-				headerType = header.Value.Schema.Value.Type
-			}
-
-			headers[name] = &openapi2.Header{
-				ExtensionProps: header.Value.ExtensionProps,
-				Description:    header.Value.Description,
-				Type:           headerType,
-			}
-
+		ref := openapi3.ParameterRef{Ref: header.Ref, Value: &header.Value.Parameter}
+		parameter, err := FromV3Parameter(&ref, components)
+		if err != nil {
+			return nil, err
 		}
+		parameter.In = ""
+		parameter.Name = ""
+		headers[name] = &openapi2.Header{Parameter: *parameter}
 	}
-
-	return headers
+	return headers, nil
 }
 
 func FromV3SecurityScheme(doc3 *openapi3.T, ref *openapi3.SecuritySchemeRef) (*openapi2.SecurityScheme, error) {

diff --git a/openapi2conv/openapi2_conv_test.go b/openapi2conv/openapi2_conv_test.go
@@ -184,7 +184,8 @@ const exampleV2 = `
 						"headers": {
 							"ETag": {
 								"description": "The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource.",
-								"type": "string"
+								"type": "string",
+								"maxLength": 64
 							}
 						}
 					},
@@ -555,7 +556,8 @@ const exampleV3 = `
 							"ETag": {
 								"description": "The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource.",
 								"schema": {
-									"type": "string"
+									"type": "string",
+									"maxLength": 64
 								}
 							}
 						}