Fix for issue 918

Headers Internal Ref Not Resolved

Author: ymohdriz

modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/util/ResolverFully.java

@@ -5,6 +5,7 @@
 import io.swagger.v3.oas.models.PathItem;
 import io.swagger.v3.oas.models.callbacks.Callback;
 import io.swagger.v3.oas.models.examples.Example;
+import io.swagger.v3.oas.models.headers.Header;
 import io.swagger.v3.oas.models.media.ArraySchema;
 import io.swagger.v3.oas.models.media.ComposedSchema;
 import io.swagger.v3.oas.models.media.MediaType;
@@ -13,6 +14,7 @@
 import io.swagger.v3.oas.models.parameters.Parameter;
 import io.swagger.v3.oas.models.parameters.RequestBody;
 import io.swagger.v3.oas.models.responses.ApiResponse;
+import io.swagger.v3.oas.models.responses.ApiResponses;
 import io.swagger.v3.parser.models.RefFormat;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -48,6 +50,7 @@ public ResolverFully(boolean aggregateCombinators) {
     private Map<String, Schema> resolvedModels = new HashMap<>();
     private Map<String, Example> examples;
     private Map<String, RequestBody> requestBodies;
+    private Map<String, Header> headers;
 
 
     public void resolveFully(OpenAPI openAPI) {
@@ -72,6 +75,13 @@ public void resolveFully(OpenAPI openAPI) {
             }
         }
 
+        if (openAPI.getComponents() != null && openAPI.getComponents().getHeaders() != null) {
+            headers = openAPI.getComponents().getHeaders();
+            if (headers == null) {
+                headers = new HashMap<>();
+            }
+        }
+
         if(openAPI.getPaths() != null) {
             for (String pathname : openAPI.getPaths().keySet()) {
                 PathItem pathItem = openAPI.getPaths().get(pathname);
@@ -138,9 +148,10 @@ public void resolvePath(PathItem pathItem){
                 }
             }
             // responses
-            if(op.getResponses() != null) {
-                for(String code : op.getResponses().keySet()) {
-                    ApiResponse response = op.getResponses().get(code);
+            ApiResponses responses = op.getResponses();
+            if(responses != null) {
+                for(String code : responses.keySet()) {
+                    ApiResponse response = responses.get(code);
                     if (response.getContent() != null) {
                         Map<String, MediaType> content = response.getContent();
                         for(String mediaType: content.keySet()){
@@ -155,11 +166,31 @@ public void resolvePath(PathItem pathItem){
                             }
                         }
                     }
+                    Map<String, Header> headers = response.getHeaders();
+                    if (headers != null) {
+                        for (Map.Entry<String, Header> header : headers.entrySet()) {
+                            Header value = header.getValue();
+                            Header resolvedValue = value.get$ref() != null ? resolveHeader(value) : value;
+                            header.setValue(resolvedValue);
+                        }
+                    }
                 }
             }
         }
     }
 
+    public Header resolveHeader(Header header){
+        RefFormat refFormat = computeRefFormat(header.get$ref());
+        String $ref = header.get$ref();
+        if (!isAnExternalRefFormat(refFormat)){
+            if (headers != null && !headers.isEmpty()) {
+                String referenceKey = computeDefinitionName($ref);
+                return headers.getOrDefault(referenceKey, header);
+            }
+        }
+        return header;
+    }
+
     public RequestBody resolveRequestBody(RequestBody requestBody){
         RefFormat refFormat = computeRefFormat(requestBody.get$ref());
         String $ref = requestBody.get$ref();

modules/swagger-parser-v3/src/test/java/io/swagger/v3/parser/test/OpenAPIV3ParserTest.java

@@ -12,6 +12,7 @@
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.Operation;
 import io.swagger.v3.oas.models.PathItem;
+import io.swagger.v3.oas.models.headers.Header;
 import io.swagger.v3.oas.models.media.*;
 import io.swagger.v3.oas.models.examples.Example;
 import io.swagger.v3.oas.models.media.ArraySchema;
@@ -1537,6 +1538,16 @@ public void shouldParseRequestBody() {
         assertEquals(actualPathContent, actualComponentContent);
     }
 
+    @Test
+    public void testIssue915() {
+        ParseOptions parseOptions = new ParseOptions();
+        parseOptions.setResolveFully(true);
+        OpenAPI openAPI = new OpenAPIV3Parser().read("src/test/resources/issue_918.yaml", null, parseOptions);
+        Map<String, Header> headers = openAPI.getPaths().get("/2.0/users/").getGet().getResponses().get("200").getHeaders();
+        String description = headers.get("X-Rate-Limit").getDescription();
+        assertEquals(description, "The number of allowed requests in the current period");
+    }
+
 
     private static int getDynamicPort() {
         return new Random().ints(10000, 20000).findFirst().getAsInt();

modules/swagger-parser-v3/src/test/resources/issue_918.yaml

@@ -0,0 +1,20 @@
+openapi: 3.0.0
+info:
+  title: headers in components
+  version: 1.0.0
+paths:
+  /2.0/users/:
+    get:
+      operationId: getUserByName
+      responses:
+        '200':
+          description: The User
+          headers:
+            X-Rate-Limit:
+              $ref: "#/components/headers/X-Rate-Limit-Ref"
+components:
+  headers:
+    X-Rate-Limit-Ref:
+      description: The number of allowed requests in the current period
+      schema:
+        type: integer