feat(oas3): add format link

Author: Marco Friso

packages/openapi3-parser/CHANGELOG.md

@@ -8,6 +8,10 @@
   This can dramatically increase the performance when dealing with documents
   which use many unsupported features.
 
+### Enhancements
+
+- added a Link element to the specific format/version in the parse result.
+
 ### Bug Fixes
 
 - Return a warning when parsing a document with a 'Media Type Object'

packages/openapi3-parser/lib/parser.js

@@ -126,14 +126,30 @@ function parse(source, context) {
     R.unless(isObjectOrAnnotation, createError(context.namespace, 'Source document is not an object')),
     R.unless(isAnnotation, parseOpenAPIObject(context)));
 
-  return R.chain(
+  const parseResult = R.chain(
     R.pipe(
       parseDocument,
       deduplicateUnsupportedAnnotations(context.namespace),
       context.options.generateSourceMap ? filterColumnLine : filterSourceMaps
     ),
     document
   );
+
+  if (!isAnnotation(parseResult.content[0])) {
+    const formatVersion = (/3\.\d+\.\d+/).exec(source)[0];
+    const formatLink = `https://spec.openapis.org/oas/v${formatVersion}`;
+
+    const { Link } = context.namespace.elements;
+    const link = new Link();
+
+    link.title = `OpenAPI ${formatVersion}`;
+    link.relation = 'via';
+    link.href = formatLink;
+
+    parseResult.links.push(link);
+  }
+
+  return parseResult;
 }
 
 module.exports = parse;

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

@@ -2,10 +2,10 @@ const { Fury } = require('@apielements/core');
 const { expect } = require('./chai');
 
 const parse = require('../../lib/parser');
+const Context = require('../../lib/context');
 
 const { minim: namespace } = new Fury();
-
-const Context = require('../../lib/context');
+const { Link } = namespace.elements;
 
 describe('#parse', () => {
   let context;
@@ -40,4 +40,15 @@ describe('#parse', () => {
     expect(parseResult.length).to.equal(1);
     expect(parseResult.api.title.toValue()).to.equal('My API');
   });
+
+  it('add the format link', () => {
+    const source = 'openapi: "3.0.0"\ninfo: {title: My API, version: 1.0.0}\npaths: {}\n';
+    const parseResult = parse(source, context);
+
+    const link = parseResult.links.get(0);
+    expect(link).to.be.instanceof(Link);
+    expect(link.relation.toValue()).to.equal('via');
+    expect(link.title.toValue()).to.equal('OpenAPI 3.0.0');
+    expect(link.href.toValue()).to.equal('https://spec.openapis.org/oas/v3.0.0');
+  });
 });