Support text-based examples in OAS 3 (#321)

Support text-based examples in OAS 3

Author: pksunkara

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

@@ -1,5 +1,12 @@
 # Fury OAS3 Parser Changelog
 
+## Master
+
+### Enhancements
+
+- Adds support for example values for text based media types such as
+  `text/*` and `application/xml`.
+
 ## 0.9.0 (2019-07-02)
 
 This release brings significant performance improvement to parsing large

packages/fury-adapter-oas3-parser/lib/parser/oas/parseMediaTypeObject.js

@@ -31,6 +31,12 @@ function isTextMediaType(mediaType) {
   return type === 'text';
 }
 
+function isXMLMediaType(mediaType) {
+  const contentType = contentTyper.parse(mediaType);
+  const { type, suffix, subtype } = mediaTyper.parse(contentType.type);
+  return type === 'application' && (suffix === 'xml' || subtype === 'xml');
+}
+
 const canGenerateMessageBodyForMediaType = R.anyPass([isJSONMediaType, isTextMediaType]);
 
 function generateMessageBody(context, mediaType, dataStructure) {
@@ -76,13 +82,27 @@ const createJSONMessageBodyAsset = R.curry((namespace, mediaType, value) => {
   return asset;
 });
 
+const createTextMessageBodyAsset = R.curry((namespace, mediaType, value) => {
+  const asset = new namespace.elements.Asset(value.toValue());
+  asset.classes.push('messageBody');
+  asset.contentType = mediaType;
+  return asset;
+});
+
 function parseExample(namespace, mediaType) {
   const createExampleNotJSONWarning = createWarning(namespace,
-    "'Media Type Object' 'example' is only supported for JSON media types");
+    `'${name}' 'example' is not supported for media type '${mediaType}'`);
+
+  const isTextBasedType = R.anyPass([
+    () => isTextMediaType(mediaType),
+    () => isXMLMediaType(mediaType),
+  ]);
 
-  return R.ifElse(() => isJSONMediaType(mediaType),
-    R.compose(createJSONMessageBodyAsset(namespace, mediaType), getValue),
-    createExampleNotJSONWarning);
+  return R.compose(R.cond([
+    [() => isJSONMediaType(mediaType), createJSONMessageBodyAsset(namespace, mediaType)],
+    [() => isTextBasedType(mediaType), createTextMessageBodyAsset(namespace, mediaType)],
+    [R.T, createExampleNotJSONWarning],
+  ]), getValue);
 }
 
 const parseSchemaObjectOrRef = parseReference('schemas', parseSchemaObject);

packages/fury-adapter-oas3-parser/test/unit/parser/oas/parseMediaTypeObject-test.js

@@ -92,8 +92,34 @@ describe('Media Type Object', () => {
       expect(message.messageBody.contentType.toValue()).to.equal('application/hal+json');
     });
 
-    it('warns for example without JSON type', () => {
+    it('creates an messageBody asset for text type with text example', () => {
+      const mediaType = new namespace.elements.Member('text/plain', {
+        example: 'Hello World',
+      });
+
+      const parseResult = parse(context, messageBodyClass, mediaType);
+
+      const message = parseResult.get(0);
+      expect(message).to.be.instanceof(messageBodyClass);
+      expect(message.messageBody.toValue()).to.equal('Hello World');
+      expect(message.messageBody.contentType.toValue()).to.equal('text/plain');
+    });
+
+    it('creates an messageBody asset for text type with xml example', () => {
       const mediaType = new namespace.elements.Member('application/xml', {
+        example: '<?xml version="1.0" encoding="UTF-8"?>',
+      });
+
+      const parseResult = parse(context, messageBodyClass, mediaType);
+
+      const message = parseResult.get(0);
+      expect(message).to.be.instanceof(messageBodyClass);
+      expect(message.messageBody.toValue()).to.equal('<?xml version="1.0" encoding="UTF-8"?>');
+      expect(message.messageBody.contentType.toValue()).to.equal('application/xml');
+    });
+
+    it('warns for example without supported media type', () => {
+      const mediaType = new namespace.elements.Member('application/plist', {
         example: {
           message: 'Hello World',
         },
@@ -106,7 +132,7 @@ describe('Media Type Object', () => {
       expect(message.messageBody).to.be.undefined;
 
       expect(parseResult).to.contain.warning(
-        "'Media Type Object' 'example' is only supported for JSON media types"
+        "'Media Type Object' 'example' is not supported for media type 'application/plist'"
       );
     });
   });