Extract headers

lib/xMsExampleExtractor.js

@@ -127,6 +127,8 @@ class xMsExampleExtractor {
                 queryParams[queryParam[0]] = queryParam[1];
               }
 
+              let headerParams = entries[entry]["RequestHeaders"];
+
               // if commandline included check for API version, validate api-version from URI in recordings matches the api-version of the spec
               if (!self.options.matchApiVersion || (("api-version" in queryParams) && queryParams["api-version"] == api.info.version)) {
                 recordingPath = recordingPath.replace(/\?.*/, '');
@@ -171,6 +173,9 @@ class xMsExampleExtractor {
                     for (let param of utils.getKeys(queryParams)) {
                       example['parameters'][param] = queryParams[param];
                     }
+                    for (let param of utils.getKeys(headerParams)) {
+                      example['parameters'][param] = headerParams[param];
+                    }
                     for (let param of utils.getKeys(infoFromOperation["parameters"])) {
                       if (params[param]["in"] == "body") {
                         let bodyParamName = params[param]["name"];

test/modelValidation/swaggers/specification/header/examples/arrayReqNotRequired.json

@@ -0,0 +1,6 @@
+{
+  "parameters": {},
+  "responses": {
+    "200": {}
+  }
+}

test/modelValidation/swaggers/specification/header/examples/arrayReqRequired.json

@@ -0,0 +1,11 @@
+{
+  "parameters": {
+    "hello": [
+      "world",
+      "galaxy"
+    ]
+  },
+  "responses": {
+    "200": {}
+  }
+}

test/modelValidation/swaggers/specification/header/examples/arrayResp.json

@@ -0,0 +1,13 @@
+{
+  "parameters": {},
+  "responses": {
+    "200": {
+      "headers": {
+        "hello": [
+          "world",
+          "galaxy"
+        ]
+      }
+    }
+  }
+}

test/modelValidation/swaggers/specification/header/examples/booleanReqNotRequired.json

@@ -0,0 +1,6 @@
+{
+  "parameters": {},
+  "responses": {
+    "200": {}
+  }
+}

test/modelValidation/swaggers/specification/header/examples/booleanReqRequired.json

@@ -0,0 +1,8 @@
+{
+  "parameters": {
+    "hello": true
+  },
+  "responses": {
+    "200": {}
+  }
+}

test/modelValidation/swaggers/specification/header/examples/booleanResp.json

@@ -0,0 +1,10 @@
+{
+  "parameters": {},
+  "responses": {
+    "200": {
+      "headers": {
+        "hello": true
+      }
+    }
+  }
+}

test/modelValidation/swaggers/specification/header/examples/integerReqNotRequired.json

@@ -0,0 +1,6 @@
+{
+  "parameters": {},
+  "responses": {
+    "200": {}
+  }
+}

test/modelValidation/swaggers/specification/header/examples/integerReqRequired.json

@@ -0,0 +1,8 @@
+{
+  "parameters": {
+    "hello": 5
+  },
+  "responses": {
+    "200": {}
+  }
+}

test/modelValidation/swaggers/specification/header/examples/integerResp.json

@@ -0,0 +1,10 @@
+{
+  "parameters": {},
+  "responses": {
+    "200": {
+      "headers": {
+        "hello": 5
+      }
+    }
+  }
+}

test/modelValidation/swaggers/specification/header/examples/stringReqNotRequired.json

@@ -0,0 +1,6 @@
+{
+  "parameters": {},
+  "responses": {
+    "200": {}
+  }
+}

test/modelValidation/swaggers/specification/header/examples/stringReqRequired.json

@@ -0,0 +1,8 @@
+{
+  "parameters": {
+    "If-Match": "World"
+  },
+  "responses": {
+    "200": {}
+  }
+}

test/modelValidation/swaggers/specification/header/examples/stringResp.json

@@ -0,0 +1,10 @@
+{
+  "parameters": {},
+  "responses": {
+    "200": {
+      "headers": {
+        "hello": "World"
+      }
+    }
+  }
+}