feat(oas3): use not supported warning for 'webhooks'

Author: kylef

packages/openapi3-parser/lib/context.js

@@ -41,6 +41,10 @@ class Context {
   isOpenAPIVersionLessThan(major, minor) {
     return this.openapiVersion.major < major || (this.openapiVersion.major === major && this.openapiVersion.minor < minor);
   }
+
+  isOpenAPIVersionMoreThanOrEqual(major, minor) {
+    return this.openapiVersion.major > major || (this.openapiVersion.major === major && this.openapiVersion.minor >= minor);
+  }
 }
 
 module.exports = Context;

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

@@ -38,6 +38,8 @@ function parseOASObject(context, object) {
     return new namespace.elements.ParseResult([array].concat(parseResult.annotations.elements));
   };
 
+  const isOpenAPI31OrHigher = () => context.isOpenAPIVersionMoreThanOrEqual(3, 1);
+
   const parseMember = R.cond([
     [hasKey('openapi'), parseOpenAPI(context)],
     [hasKey('servers'), R.compose(parseServersArray(context, name), getValue)],
@@ -49,6 +51,10 @@ function parseOASObject(context, object) {
     // FIXME Support exposing extensions into parse result
     [isExtension, () => new namespace.elements.ParseResult()],
 
+    [
+      R.both(hasKey('webhooks'), isOpenAPI31OrHigher),
+      createUnsupportedMemberWarning(namespace, name),
+    ],
     [isUnsupportedKey, createUnsupportedMemberWarning(namespace, name)],
 
     // Return a warning for additional properties

packages/openapi3-parser/test/unit/parser/oas/parseOpenAPIObject-test.js

@@ -239,6 +239,38 @@ describe('#parseOpenAPIObject', () => {
     expect(parseResult).to.contain.warning("'OpenAPI Object' contains unsupported key 'externalDocs'");
   });
 
+  it('provides warning for unsupported webhooks key in OpenAPI 3.1', () => {
+    const object = new namespace.elements.Object({
+      openapi: '3.1.0',
+      info: {
+        title: 'My API',
+        version: '1.0.0',
+      },
+      paths: {},
+      webhooks: {},
+    });
+
+    const parseResult = parse(context, object);
+
+    expect(parseResult.warnings.get(1).toValue()).to.equal("'OpenAPI Object' contains unsupported key 'webhooks'");
+  });
+
+  it('provides warning for invalid key webhooks in OpenAPI 3.0', () => {
+    const object = new namespace.elements.Object({
+      openapi: '3.0.0',
+      info: {
+        title: 'My API',
+        version: '1.0.0',
+      },
+      paths: {},
+      webhooks: {},
+    });
+
+    const parseResult = parse(context, object);
+
+    expect(parseResult).to.contain.warning("'OpenAPI Object' contains invalid key 'webhooks'");
+  });
+
   it('provides warning for invalid keys', () => {
     const object = new namespace.elements.Object({
       openapi: '3.0.0',