Merge pull request #486 from apiaryio/kylef/oas-header

Return unsupported warnings in header object instead of invalid

Author: kylef

packages/openapi3-parser/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Fury OAS3 Parser Changelog
 
+## Master
+
+### Bug Fixes
+
+- Prior versions of the adapter reported the following 'Header Object' keys as
+  invalid: `style`, `explode`, `allowReserved`, `schema`, `content`, `example`,
+  and `examples`. These will now return an unsupported warning instead.
+
 ## 0.13.0 (2020-06-12)
 
 The package has been updated for compatibility with `@apielements/core`.

packages/openapi3-parser/lib/parser/oas/parseHeaderObject.js

@@ -10,6 +10,8 @@ const parseObject = require('../parseObject');
 const name = 'Header Object';
 const unsupportedKeys = [
   'description', 'required', 'deprecated', 'allowEmptyValue',
+  'style', 'explode', 'allowReserved', 'schema', 'content', 'example',
+  'examples',
 ];
 const isUnsupportedKey = R.anyPass(R.map(hasKey, unsupportedKeys));
 

packages/openapi3-parser/test/integration/fixtures/petstore.json

@@ -1035,7 +1035,7 @@
           ]
         }
       },
-      "content": "'Header Object' contains invalid key 'schema'"
+      "content": "'Header Object' contains unsupported key 'schema'"
     },
     {
       "element": "annotation",

packages/openapi3-parser/test/integration/fixtures/petstore.sourcemap.json

@@ -1985,7 +1985,7 @@
           ]
         }
       },
-      "content": "'Header Object' contains invalid key 'schema'"
+      "content": "'Header Object' contains unsupported key 'schema'"
     },
     {
       "element": "annotation",