feat: Improved openapi.version handling

Closes #32

Author: klokane

packages/fury-adapter-oas3-parser/STATUS.md

@@ -15,7 +15,7 @@ Key:
 
 | Field Name | Support |
 |:--|:--|
-| openapi | [~](https://github.com/apiaryio/fury-adapter-parser-oas3/issues/32) |
+| openapi | ✓ |
 | info | [~](https://github.com/apiaryio/fury-adapter-parser-oas3/issues/30) |
 | servers | [✕](https://github.com/apiaryio/fury-adapter-parser-oas3/issues/24) |
 | paths | ~ |

packages/fury-adapter-oas3-parser/lib/parser/openapi.js

@@ -1,17 +1,33 @@
 const R = require('ramda');
-const { createError } = require('../elements');
+const { createError, createWarning } = require('../elements');
 const { isString } = require('../predicates');
 
+const semanticVersionRE = /^(\d+)\.(\d+).(\d+)$/;
+
+const supportedMinorVersion = 0;
+const supportedMajorVersion = 3;
+
 // Parse the OpenAPI Version member
 function parseOpenAPI(minim, openapi) {
   if (!isString(openapi.value)) {
     return new minim.elements.ParseResult([createError(minim, 'OpenAPI version is not a string', openapi.value)]);
   }
 
-  if (openapi.value.toValue() !== '3.0.0') {
+  const versionInfo = openapi.value.toValue().match(semanticVersionRE);
+
+  if (versionInfo === null) {
+    return new minim.elements.ParseResult([createError(minim, `OpenAPI version does not contain valid semantic version string '${openapi.value.toValue()}'`, openapi.value)]);
+  }
+
+  if (parseInt(versionInfo[1], 10) !== supportedMajorVersion) {
     return new minim.elements.ParseResult([createError(minim, `Unsupported OpenAPI version '${openapi.value.toValue()}'`, openapi.value)]);
   }
 
+  if (parseInt(versionInfo[2], 10) > supportedMinorVersion) {
+    return new minim.elements.ParseResult([createWarning(minim, `Version '${openapi.value.toValue()}' is not fully supported`, openapi.value)]);
+  }
+
+
   return new minim.elements.ParseResult([]);
 }
 

packages/fury-adapter-oas3-parser/test/parser/openapi-test.js

@@ -15,7 +15,16 @@ describe('#parseOpenAPI', () => {
     expect(parseResult.errors.getValue(0)).to.equal('OpenAPI version is not a string');
   });
 
-  it('fails to parse unknown version', () => {
+  it('fails to parse non valid semantic version', () => {
+    const openapi = new minim.elements.Member('openapi', '3.0');
+
+    const parseResult = parseOpenAPI(minim, openapi);
+    expect(parseResult).to.be.instanceof(minim.elements.ParseResult);
+    expect(parseResult.errors.length).to.equal(1);
+    expect(parseResult.errors.getValue(0)).to.equal("OpenAPI version does not contain valid semantic version string '3.0'");
+  });
+
+  it('fails to parse unknown major version', () => {
     const openapi = new minim.elements.Member('openapi', '4.0.0');
 
     const parseResult = parseOpenAPI(minim, openapi);
@@ -31,4 +40,21 @@ describe('#parseOpenAPI', () => {
     expect(parseResult).to.be.instanceof(minim.elements.ParseResult);
     expect(parseResult.isEmpty).to.be.true;
   });
+
+  it('allows openapi patch version 3.0.11', () => {
+    const openapi = new minim.elements.Member('openapi', '3.0.11');
+
+    const parseResult = parseOpenAPI(minim, openapi);
+    expect(parseResult).to.be.instanceof(minim.elements.ParseResult);
+    expect(parseResult.isEmpty).to.be.true;
+  });
+
+  it('warns for unsuported minor versions', () => {
+    const openapi = new minim.elements.Member('openapi', '3.1.0');
+
+    const parseResult = parseOpenAPI(minim, openapi);
+    expect(parseResult).to.be.instanceof(minim.elements.ParseResult);
+    expect(parseResult.warnings.length).to.equal(1);
+    expect(parseResult.warnings.getValue(0)).to.equal("Version '3.1.0' is not fully supported");
+  });
 });